github-mirror/grocy
1
0
Fork 0
mirror of https://github.com/grocy/grocy.git synced 2026-03-27 23:29:25 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Adding two new plugins, one for OpenBeautyFacts and one a combination of the existing OpenFoodFact and OpenBeautyFact

Browse Source
This commit is contained in:
dotnjet 2025-12-08 20:15:12 +01:00
parent 8108749d9d
commit 24bdcba474
2 changed files with 174 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
plugins/OpenBeautyFactsBarcodeLookupPlugin.php Normal file
View File

@ -0,0 +1,74 @@
<?php
use Grocy\Helpers\BaseBarcodeLookupPlugin;
use GuzzleHttp\Client;
/*
To use this plugin, configure it in data/config.php like this:
Setting('STOCK_BARCODE_LOOKUP_PLUGIN', 'OpenBeautyFactsBarcodeLookupPlugin');
*/
class OpenBeautyFactsBarcodeLookupPlugin extends BaseBarcodeLookupPlugin
{
public const PLUGIN_NAME = 'Open Food Facts';
protected function ExecuteLookup($barcode)
{
$productNameFieldLocalized = 'product_name_' . substr(GROCY_LOCALE, 0, 2);
$webClient = new Client(['http_errors' => false]);
$response = $webClient->request('GET', 'https://world.openbeautyfacts.org/api/v2/product/' . preg_replace('/[^0-9]/', '', $barcode) . '?fields=product_name,image_url,' . $productNameFieldLocalized, ['headers' => ['User-Agent' => 'GrocyOpenFoodFactsBarcodeLookupPlugin/1.0 (https://grocy.info)']]);
$statusCode = $response->getStatusCode();
// Guzzle throws exceptions for connection errors, so nothing to do on that here
$data = json_decode($response->getBody());
if ($statusCode == 404 || $data->status != 1)
{
// Nothing found for the given barcode
return null;
}
else
{
$imageUrl = '';
if (isset($data->product->image_url) && !empty($data->product->image_url))
{
$imageUrl = $data->product->image_url;
}
// Take the preset user setting or otherwise simply the first existing location
$locationId = $this->Locations[0]->id;
if ($this->UserSettings['product_presets_location_id'] != -1)
{
$locationId = $this->UserSettings['product_presets_location_id'];
}
// Take the preset user setting or otherwise simply the first existing quantity unit
$quId = $this->QuantityUnits[0]->id;
if ($this->UserSettings['product_presets_qu_id'] != -1)
{
$quId = $this->UserSettings['product_presets_qu_id'];
}
// Use the localized product name, if provided
$name = $data->product->product_name;
if (isset($data->product->$productNameFieldLocalized) && !empty($data->product->$productNameFieldLocalized))
{
$name = $data->product->$productNameFieldLocalized;
}
// Remove non-ASCII characters in product name (whyever a product name should have them at all)
$name = preg_replace('/[^a-zA-Z0-9äöüÄÖÜß ]/', '', $name);
return [
'name' => $name,
'location_id' => $locationId,
'qu_id_purchase' => $quId,
'qu_id_stock' => $quId,
'__qu_factor_purchase_to_stock' => 1,
'__barcode' => $barcode,
'__image_url' => $imageUrl
];
}
}
}

100
plugins/OpenFoodAndBeautyFactsBarcodeLookupPlugin.php Normal file
View File

@ -0,0 +1,100 @@
<?php
use Grocy\Helpers\BaseBarcodeLookupPlugin;
use GuzzleHttp\Client;
/*
To use this plugin, configure it in data/config.php like this:
Setting('STOCK_BARCODE_LOOKUP_PLUGIN', 'OpenFoodAndBeautyFactsBarcodeLookupPlugin');
*/
class OpenFoodAndBeautyFactsBarcodeLookupPlugin extends BaseBarcodeLookupPlugin
{
public const PLUGIN_NAME = 'Open Food Facts';
protected function ExecuteLookup($barcode)
{
// Function to perform the actual lookup
function performLookup($apiUrl, $barcode, $productNameFieldLocalized, $webClient)
{
// Make the API request
$response = $webClient->request(
'GET',
$apiUrl . preg_replace('/[^0-9]/', '', $barcode) . '?fields=product_name,image_url,' . $productNameFieldLocalized,
['headers' => ['User-Agent' => 'GrocyOpenFoodFactsBarcodeLookupPlugin/1.0 (https://grocy.info)']]
);
// Parse the response
$statusCode = $response->getStatusCode();
$data = json_decode($response->getBody());
// Check if the product was not found
if ($statusCode == 404 || $data->status != 1)
{
return null;
}
// Return the response data
return $data;
}
$productNameFieldLocalized = 'product_name_' . substr(GROCY_LOCALE, 0, 2);
$webClient = new Client(['http_errors' => false]);
// First lookup on Open Food Facts
$data = performLookup('https://world.openfoodfacts.org/api/v2/product/', $barcode, $productNameFieldLocalized, $webClient);
// If the first lookup fails, try the Open Beauty Facts
if ($data === null)
{
$data = performLookup('https://world.openbeautyfacts.org/api/v2/product/', $barcode, $productNameFieldLocalized, $webClient);
// If the second lookup fails too, return null
if ($data === null)
{
return null;
}
}
// Initialize an empty image URL
$imageUrl = '';
if (isset($data->product->image_url) && !empty($data->product->image_url))
{
$imageUrl = $data->product->image_url;
}
// Retrieve the location ID from user settings or set to the first location in the list
$locationId = $this->Locations[0]->id;
if ($this->UserSettings['product_presets_location_id'] != -1)
{
$locationId = $this->UserSettings['product_presets_location_id'];
}
// Retrieve the quantity unit ID from user settings or set to the first quantity unit in the list
$quId = $this->QuantityUnits[0]->id;
if ($this->UserSettings['product_presets_qu_id'] != -1)
{
$quId = $this->UserSettings['product_presets_qu_id'];
}
// Use the localized product name if provided
$name = $data->product->product_name;
if (isset($data->product->$productNameFieldLocalized) && !empty($data->product->$productNameFieldLocalized))
{
$name = $data->product->$productNameFieldLocalized;
}
// Remove non-ASCII characters from the product name
$name = preg_replace('/[^a-zA-Z0-9äöüÄÖÜß ]/', '', $name);
// Return the structured product data
return [
'name' => $name,
'location_id' => $locationId,
'qu_id_purchase' => $quId,
'qu_id_stock' => $quId,
'__qu_factor_purchase_to_stock' => 1,
'__barcode' => $barcode,
'__image_url' => $imageUrl
];
}
}