feat: nutripatrol product report (#10991)

First Nutri-Patrol integration. --------- Co-authored-by: Open Food Facts Bot <contact@openfoodfacts.org> Co-authored-by: Stéphane Gigandet <stephane@openfoodfacts.org>
openfoodfacts · Nov 25, 2024 · 6e4d43a · 6e4d43a
1 parent 046d898
commit 6e4d43a
Show file tree

Hide file tree

Showing 34 changed files with 523 additions and 15 deletions.
diff --git a/.env b/.env
@@ -72,6 +72,10 @@ ODOO_CRM_DB=
 ODOO_CRM_USER=
 ODOO_CRM_PASSWORD=
 
+# No need to have it running, it's just to compose a URL
+# you might also use the .net service
+NUTRIPATROL_URL=nutripatrol.localhost
+
 BUILD_CACHE_REPO=openfoodfacts/openfoodfacts-build-cache
 
 # If you want the rate limiter to block requests (return 429) instead of doing nothing,

diff --git a/.github/workflows/container-deploy.yml b/.github/workflows/container-deploy.yml
@@ -39,6 +39,7 @@ jobs:
         echo "GEOLITE2_PATH=/usr/local/share/GeoLite2-Country/GeoLite2-Country.mmdb" >> $GITHUB_ENV
         echo "INFLUXDB_HOST=10.1.0.200" >> $GITHUB_ENV
         echo "FACETS_KP_URL=https://facets-kp.openfoodfacts.net/render-to-html" >> $GITHUB_ENV
+        echo "NUTRIPATROL_URL=nutripatrol.openfoodfacts.net" >> $GITHUB_ENV
         # deploy target
         echo "SSH_HOST=10.1.0.200" >> $GITHUB_ENV
         echo "SSH_PROXY_HOST=ovh1.openfoodfacts.org" >> $GITHUB_ENV
@@ -167,6 +168,7 @@ jobs:
           echo "QUERY_URL=${{ env.QUERY_URL }}" >> .env
           echo "REDIS_URL=${{ env.REDIS_URL }}" >> .env
           echo "FACETS_KP_URL=${{ env.FACETS_KP_URL }}" >> .env
+          echo "NUTRIPATROL_URL=${{ env.NUTRIPATROL_URL }}" >> .env
           echo "GOOGLE_CLOUD_VISION_API_KEY=${{ secrets.GOOGLE_CLOUD_VISION_API_KEY }}" >> .env
           echo "CROWDIN_PROJECT_IDENTIFIER=${{ env.CROWDIN_PROJECT_IDENTIFIER }}" >> .env
           echo "CROWDIN_PROJECT_KEY=${{ secrets.CROWDIN_PROJECT_KEY }}" >> .env

diff --git a/cgi/product_multilingual.pl b/cgi/product_multilingual.pl
@@ -1649,7 +1649,7 @@ ($product_ref, $field, $language, $request_ref)
 
 	$template_data_ref_process->{edited_product_url}
 		= $url_prefix . get_owner_pretty_path() . product_url($product_ref);
-	$template_data_ref_process->{edit_product_url} = $url_prefix . product_action_url($product_ref->{code}, "");
+	$template_data_ref_process->{edit_product_url} = $url_prefix . product_action_url($product_ref->{code});
 
 	if ($type ne 'delete') {
 		# adding contribution card

diff --git a/conf/apache-2.4/modperl.conf b/conf/apache-2.4/modperl.conf
@@ -24,6 +24,7 @@ PerlPassEnv POSTGRES_PASSWORD
 PerlPassEnv LOG_LEVEL_ROOT
 PerlPassEnv LOG_LEVEL_MONGODB
 PerlPassEnv LOG_LEVEL_RATE_LIMITER
+PerlPassEnv NUTRIPATROL_URL
 PerlPassEnv OFF_LOG_EMAILS
 PerlPassEnv BUILD_CACHE_REPO
 PerlPassEnv RATE_LIMITER_BLOCKING_ENABLED

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -28,6 +28,7 @@ x-backend-conf: &backend-conf
     - LOG_LEVEL_ROOT
     - LOG_LEVEL_MONGODB
     - LOG_LEVEL_RATE_LIMITER
+    - NUTRIPATROL_URL
     - INFLUXDB_HOST
     - BUILD_CACHE_REPO
     - RATE_LIMITER_BLOCKING_ENABLED

diff --git a/env/env.obf b/env/env.obf
@@ -5,4 +5,5 @@ COMPOSE_PROJECT_NAME=po_obf
 
 PRODUCT_OPENER_FLAVOR=openbeautyfacts
 PRODUCT_OPENER_FLAVOR_SHORT=obf
-ROBOTOFF_URL=https://robotoff.openfoodfacts.org
+ROBOTOFF_URL=https://robotoff.openfoodfacts.org
+NUTRIPATROL_URL=https://nutripatrol.openfoodfacts.org/
diff --git a/env/env.off b/env/env.off
@@ -5,3 +5,5 @@ COMPOSE_PROJECT_NAME=po_off
 
 PRODUCT_OPENER_FLAVOR=openfoodfacts
 PRODUCT_OPENER_FLAVOR_SHORT=off
+
+NUTRIPATROL_URL=https://nutripatrol.openfoodfacts.org/
diff --git a/env/env.opf b/env/env.opf
@@ -5,3 +5,5 @@ COMPOSE_PROJECT_NAME=po_opf
 
 PRODUCT_OPENER_FLAVOR=openproductfacts
 PRODUCT_OPENER_FLAVOR_SHORT=opf
+
+NUTRIPATROL_URL=https://nutripatrol.openfoodfacts.org/
diff --git a/env/env.opff b/env/env.opff
@@ -5,3 +5,5 @@ COMPOSE_PROJECT_NAME=po_opff
 
 PRODUCT_OPENER_FLAVOR=openpetfoodfacts
 PRODUCT_OPENER_FLAVOR_SHORT=opff
+
+NUTRIPATROL_URL=https://nutripatrol.openfoodfacts.org/
diff --git a/lib/ProductOpener/ConfigEnv.pm b/lib/ProductOpener/ConfigEnv.pm
@@ -0,0 +1,37 @@
+# This file is part of Product Opener.
+#
+# Product Opener
+# Copyright (C) 2011-2024 Association Open Food Facts
+# Contact: contact@openfoodfacts.org
+# Address: 21 rue des Iles, 94100 Saint-Maur des Fossés, France
+#
+# Product Opener is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+package ProductOpener::ConfigEnv;
+
+use ProductOpener::PerlStandards;
+use Exporter qw< import >;
+
+BEGIN {
+	use vars qw(@ISA @EXPORT_OK %EXPORT_TAGS);
+	@EXPORT_OK = qw(
+		$nutripatrol_url
+	);
+	%EXPORT_TAGS = (all => [@EXPORT_OK]);
+}
+use vars @EXPORT_OK;    # no 'my' keyword for these
+
+$nutripatrol_url = $ENV{NUTRIPATROL_URL};
+
+1;
diff --git a/lib/ProductOpener/KnowledgePanelsReportProblem.pm b/lib/ProductOpener/KnowledgePanelsReportProblem.pm
@@ -48,7 +48,8 @@ BEGIN {
 use vars @EXPORT_OK;
 
 use ProductOpener::KnowledgePanels qw(create_panel_from_json_template);
-use ProductOpener::Tags qw(:all);
+use ProductOpener::Tags qw/:all/;
+use ProductOpener::ConfigEnv qw/:all/;
 
 use Encode;
 use Data::DeepAccess qw(deep_get);
@@ -87,16 +88,15 @@ sub create_report_problem_card_panel ($product_ref, $target_lc, $target_cc, $opt
 	# + add promo message for the pro platform ("Are you the owner? Add your contact information")
 
 	# Panel to tell users that they can fix the data themselves
-
+	# or report to nutripatrol
 	create_panel_from_json_template(
 		"incomplete_or_incorrect_data",
 		"api/knowledge-panels/report_problem/incomplete_or_incorrect_data.tt.json",
-		{}, $product_ref, $target_lc, $target_cc, $options_ref
+		{nutripatrol_enabled => !!$nutripatrol_url},
+		$product_ref, $target_lc, $target_cc, $options_ref
 	);
 	push(@panels, "incomplete_or_incorrect_data");
 
-	# TODO: add a panel for Nutri-Patrol once it is ready
-
 	# Panels to report product issues to local authorities
 
 	# France - SignalConso

diff --git a/lib/ProductOpener/Products.pm b/lib/ProductOpener/Products.pm
@@ -124,6 +124,7 @@ use vars @EXPORT_OK;
 
 use ProductOpener::Store qw/get_string_id_for_lang get_url_id_for_lang retrieve store/;
 use ProductOpener::Config qw/:all/;
+use ProductOpener::ConfigEnv qw/:all/;
 use ProductOpener::Paths qw/%BASE_DIRS ensure_dir_created_or_die/;
 use ProductOpener::Users qw/$Org_id $Owner_id $User_id %User init_user/;
 use ProductOpener::Orgs qw/retrieve_org/;
@@ -2738,20 +2739,31 @@ my %actions_urls = (
 	add_packager_codes_image => "#packager_codes",
 	add_labels => "#labels",
 	add_countries => "#countries",
+	# this is for web rendering so source is web
+	report_product_to_nutripatrol => "$nutripatrol_url/flag/product/?barcode=PRODUCT_CODE&source=web&flavor=$flavor"
 );
 
-sub product_action_url ($code, $action) {
-
-	my $url = "/cgi/product.pl?type=edit&code=" . $code;
+sub product_action_url ($code, $action = "edit_product") {
 
+	my $url;
 	if (defined $actions_urls{$action}) {
-		$url .= $actions_urls{$action};
+		my $action_url = $actions_urls{$action};
+		if (($action_url eq '') || ($action_url =~ /^#/)) {
+			# link to the edit form
+			$url = "/cgi/product.pl?type=edit&code=" . $code;
+			$url .= $action_url;
+		}
+		else {
+			# full url
+			$url = $action_url;
+			$url =~ s/PRODUCT_CODE/$code/;
+		}
 	}
 	else {
 		$log->error("unknown product action", {code => $code, action => $action});
 	}
 
-	return $url;
+	return $url // "";
 }
 
 sub compute_keywords ($product_ref) {

diff --git a/po/common/common.pot b/po/common/common.pot
@@ -6359,6 +6359,10 @@ msgctxt "action_packager_codes_image"
 msgid "Take a photo of traceability codes"
 msgstr "Take a photo of traceability codes"
 
+msgctxt "action_report_product_to_nutripatrol"
+msgid "Report this product to our moderators"
+msgstr "Report this product to our moderators"
+
 # Used as a header for key facts
 msgctxt "knowledge_panels_facts"
 msgid "What you need to know"
@@ -6969,6 +6973,10 @@ msgctxt "incomplete_or_incorrect_data_content_correct_off"
 msgid "Open Food Facts is a collaborative database, and every contribution is useful for all."
 msgstr "Open Food Facts is a collaborative database, and every contribution is useful for all."
 
+msgctxt "report_to_nutripatrol_explain"
+msgid "If you want to report vandalism, inappropriate content or erroneous data you can't fix yourself, report it to our moderators team."
+msgstr "If you want to report vandalism, inappropriate content or erroneous data you can't fix yourself, report it to our moderators team."
+
 msgctxt "description"
 msgid "Description"
 msgstr "Description"

diff --git a/po/common/en.po b/po/common/en.po
@@ -6378,6 +6378,10 @@ msgctxt "action_packager_codes_image"
 msgid "Take a photo of traceability codes"
 msgstr "Take a photo of traceability codes"
 
+msgctxt "action_report_product_to_nutripatrol"
+msgid "Report this product to our moderators"
+msgstr "Report this product to our moderators"
+
 # Used as a header for key facts
 msgctxt "knowledge_panels_facts"
 msgid "What you need to know"
@@ -6982,6 +6986,10 @@ msgctxt "incomplete_or_incorrect_data_content_correct_off"
 msgid "Open Food Facts is a collaborative database, and every contribution is useful for all."
 msgstr "Open Food Facts is a collaborative database, and every contribution is useful for all."
 
+msgctxt "report_to_nutripatrol_explain"
+msgid "If you want to report vandalism, inappropriate content or erroneous data you can't fix yourself, report it to our moderators team."
+msgstr "If you want to report vandalism, inappropriate content or erroneous data you can't fix yourself, report it to our moderators team."
+
 msgctxt "description"
 msgid "Description"
 msgstr "Description"

diff --git a/templates/api/knowledge-panels/report_problem/incomplete_or_incorrect_data.tt.json b/templates/api/knowledge-panels/report_problem/incomplete_or_incorrect_data.tt.json
@@ -17,7 +17,7 @@
                 "html": `
                 [% lang('incomplete_or_incorrect_data_content_correct') %]
                 [% lang('incomplete_or_incorrect_data_content_correct_off') %]
-                `
+                `         
             },
         },
         {
@@ -26,6 +26,23 @@
                 "html": "",
                 "actions": ["edit_product"]
             }
-        }          
+        },
+        [% IF panel.nutripatrol_enabled and !mobile %]
+        {
+            "element_type": "text",
+            "text_element": {
+                "html": `
+                [% lang('report_to_nutripatrol_explain') %]
+                `
+            },
+        },
+        {
+            "element_type": "action",
+            "action_element": {
+                "html": "",
+                "actions": ["report_product_to_nutripatrol"]
+            }
+        },
+        [% END %]
     ]
-}
+}
diff --git a/...ntegration/expected_test_results/api_v2_product_read/get-fields-all-knowledge-panels.json b/...ntegration/expected_test_results/api_v2_product_read/get-fields-all-knowledge-panels.json
@@ -1351,6 +1351,21 @@
                      "html" : ""
                   },
                   "element_type" : "action"
+               },
+               {
+                  "element_type" : "text",
+                  "text_element" : {
+                     "html" : "\n                If you want to report vandalism, inappropriate content or erroneous data you can't fix yourself, report it to our moderators team.\n                "
+                  }
+               },
+               {
+                  "action_element" : {
+                     "actions" : [
+                        "report_product_to_nutripatrol"
+                     ],
+                     "html" : ""
+                  },
+                  "element_type" : "action"
                }
             ],
             "evaluation" : "neutral",

diff --git a/...ed_test_results/api_v2_product_read/get-fields-attribute-groups-all-knowledge-panels.json b/...ed_test_results/api_v2_product_read/get-fields-attribute-groups-all-knowledge-panels.json
@@ -2007,6 +2007,21 @@
                      "html" : ""
                   },
                   "element_type" : "action"
+               },
+               {
+                  "element_type" : "text",
+                  "text_element" : {
+                     "html" : "\n                If you want to report vandalism, inappropriate content or erroneous data you can't fix yourself, report it to our moderators team.\n                "
+                  }
+               },
+               {
+                  "action_element" : {
+                     "actions" : [
+                        "report_product_to_nutripatrol"
+                     ],
+                     "html" : ""
+                  },
+                  "element_type" : "action"
                }
             ],
             "evaluation" : "neutral",

diff --git a/..._product_read/get-fields-knowledge-panels-knowledge-panels_excluded-environment_card.json b/..._product_read/get-fields-knowledge-panels-knowledge-panels_excluded-environment_card.json
@@ -82,6 +82,21 @@
                      "html" : ""
                   },
                   "element_type" : "action"
+               },
+               {
+                  "element_type" : "text",
+                  "text_element" : {
+                     "html" : "\n                If you want to report vandalism, inappropriate content or erroneous data you can't fix yourself, report it to our moderators team.\n                "
+                  }
+               },
+               {
+                  "action_element" : {
+                     "actions" : [
+                        "report_product_to_nutripatrol"
+                     ],
+                     "html" : ""
+                  },
+                  "element_type" : "action"
                }
             ],
             "evaluation" : "neutral",

diff --git a/tests/integration/expected_test_results/api_v2_product_read/get-knowledge-panels-fr.json b/tests/integration/expected_test_results/api_v2_product_read/get-knowledge-panels-fr.json
@@ -645,6 +645,21 @@
                      "html" : ""
                   },
                   "element_type" : "action"
+               },
+               {
+                  "element_type" : "text",
+                  "text_element" : {
+                     "html" : "\n                If you want to report vandalism, inappropriate content or erroneous data you can't fix yourself, report it to our moderators team.\n                "
+                  }
+               },
+               {
+                  "action_element" : {
+                     "actions" : [
+                        "report_product_to_nutripatrol"
+                     ],
+                     "html" : ""
+                  },
+                  "element_type" : "action"
                }
             ],
             "evaluation" : "neutral",

diff --git a/tests/integration/expected_test_results/api_v2_product_read/get-knowledge-panels.json b/tests/integration/expected_test_results/api_v2_product_read/get-knowledge-panels.json
@@ -645,6 +645,21 @@
                      "html" : ""
                   },
                   "element_type" : "action"
+               },
+               {
+                  "element_type" : "text",
+                  "text_element" : {
+                     "html" : "\n                If you want to report vandalism, inappropriate content or erroneous data you can't fix yourself, report it to our moderators team.\n                "
+                  }
+               },
+               {
+                  "action_element" : {
+                     "actions" : [
+                        "report_product_to_nutripatrol"
+                     ],
+                     "html" : ""
+                  },
+                  "element_type" : "action"
                }
             ],
             "evaluation" : "neutral",
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,3 +5,5 @@ COMPOSE_PROJECT_NAME=po_off

		PRODUCT_OPENER_FLAVOR=openfoodfacts
		PRODUCT_OPENER_FLAVOR_SHORT=off

		NUTRIPATROL_URL=https://nutripatrol.openfoodfacts.org/
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,3 +5,5 @@ COMPOSE_PROJECT_NAME=po_opf

		PRODUCT_OPENER_FLAVOR=openproductfacts
		PRODUCT_OPENER_FLAVOR_SHORT=opf

		NUTRIPATROL_URL=https://nutripatrol.openfoodfacts.org/
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,3 +5,5 @@ COMPOSE_PROJECT_NAME=po_opff

		PRODUCT_OPENER_FLAVOR=openpetfoodfacts
		PRODUCT_OPENER_FLAVOR_SHORT=opff

		NUTRIPATROL_URL=https://nutripatrol.openfoodfacts.org/