Squashed commit

Improve journal pages loading time (new date range filter) Various small style adjustments (meal plan page and others) Pulled German translations from Transifex Show the shopping list total value (closes #1309) Make it possible to copy recipes (closes #714) Implemented optional "auto decimal separator for price inputs" (closes #1345) Removed table grouped column fixed order restriction (closes #1402) Don't filter out style, class, id attributes of html text (closes #1298) Added product picture as column on the stock overview page (closes #1283) Added grocycodes also for chores and batteries (+ camera barcode scanning for /choretracking and /batterytracking, this now closes #221)
2025-10-14 09:11:11 +00:00 · 2021-07-13 19:29:23 +02:00
parent 8d2c3ae584
commit 91d8eaeb74
70 changed files with 1476 additions and 491 deletions
--- a/controllers/BaseController.php
+++ b/controllers/BaseController.php
@@ -210,7 +210,8 @@ class BaseController
 		{
 			$htmlPurifierConfig = \HTMLPurifier_Config::createDefault();
 			$htmlPurifierConfig->set('Cache.SerializerPath', GROCY_DATAPATH . '/viewcache');
-			$htmlPurifierConfig->set('HTML.Allowed', 'div,b,strong,i,em,u,a[href|title|target],iframe[src|width|height|frameborder],ul,ol,li,p[style],br,span[style],img[width|height|alt|src],table[border|width|style],tbody,tr,td,th,blockquote');
+			$htmlPurifierConfig->set('HTML.Allowed', 'div,b,strong,i,em,u,a[href|title|target],iframe[src|width|height|frameborder],ul,ol,li,p[style],br,span[style],img[width|height|alt|src],table[border|width|style],tbody,tr,td,th,blockquote,*[style|class|id]');
+			$htmlPurifierConfig->set('Attr.EnableID', true);
 			$htmlPurifierConfig->set('HTML.SafeIframe', true);
 			$htmlPurifierConfig->set('CSS.AllowedProperties', 'font,font-size,font-weight,font-style,font-family,text-decoration,padding-left,color,background-color,text-align');
 			$htmlPurifierConfig->set('URI.AllowedSchemes', ['data' => true, 'http' => true, 'https' => true]);
--- a/controllers/BatteriesApiController.php
+++ b/controllers/BatteriesApiController.php
@@ -3,6 +3,8 @@
 namespace Grocy\Controllers;

 use Grocy\Controllers\Users\User;
+use Grocy\Helpers\WebhookRunner;
+use Grocy\Helpers\Grocycode;

 class BatteriesApiController extends BaseApiController
 {
@@ -62,6 +64,30 @@ class BatteriesApiController extends BaseApiController
 		}
 	}

+	public function BatteryPrintLabel(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response, array $args)
+	{
+		try
+		{
+			$battery = $this->getDatabase()->batteries()->where('id', $args['batteryId'])->fetch();
+
+			$webhookData = array_merge([
+				'battery' => $battery->name,
+				'grocycode' => (string)(new Grocycode(Grocycode::BATTERY, $args['batteryId'])),
+			], GROCY_LABEL_PRINTER_PARAMS);
+
+			if (GROCY_LABEL_PRINTER_RUN_SERVER)
+			{
+				(new WebhookRunner())->run(GROCY_LABEL_PRINTER_WEBHOOK, $webhookData, GROCY_LABEL_PRINTER_HOOK_JSON);
+			}
+
+			return $this->ApiResponse($response, $webhookData);
+		}
+		catch (\Exception $ex)
+		{
+			return $this->GenericErrorResponse($response, $ex->getMessage());
+		}
+	}
+
 	public function __construct(\DI\Container $container)
 	{
 		parent::__construct($container);
--- a/controllers/BatteriesController.php
+++ b/controllers/BatteriesController.php
@@ -2,6 +2,10 @@

 namespace Grocy\Controllers;

+use Grocy\Helpers\Grocycode;
+use jucksearm\barcode\lib\BarcodeFactory;
+use jucksearm\barcode\lib\DatamatrixFactory;
+
 class BatteriesController extends BaseController
 {
 	public function BatteriesList(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response, array $args)
@@ -48,8 +52,25 @@ class BatteriesController extends BaseController

 	public function Journal(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response, array $args)
 	{
+		if (isset($request->getQueryParams()['months']) && filter_var($request->getQueryParams()['months'], FILTER_VALIDATE_INT) !== false)
+		{
+			$months = $request->getQueryParams()['months'];
+			$where = "tracked_time > DATE(DATE('now', 'localtime'), '-$months months')";
+		}
+		else
+		{
+			// Default 2 years
+			$where = "tracked_time > DATE(DATE('now', 'localtime'), '-24 months')";
+		}
+
+		if (isset($request->getQueryParams()['battery']) && filter_var($request->getQueryParams()['battery'], FILTER_VALIDATE_INT) !== false)
+		{
+			$batteryId = $request->getQueryParams()['battery'];
+			$where .= " AND battery_id = $batteryId";
+		}
+
 		return $this->renderPage($response, 'batteriesjournal', [
-			'chargeCycles' => $this->getDatabase()->battery_charge_cycles()->orderBy('tracked_time', 'DESC'),
+			'chargeCycles' => $this->getDatabase()->battery_charge_cycles()->where($where)->orderBy('tracked_time', 'DESC'),
 			'batteries' => $this->getDatabase()->batteries()->where('active = 1')->orderBy('name', 'COLLATE NOCASE')
 		]);
 	}
@@ -75,6 +96,40 @@ class BatteriesController extends BaseController
 		]);
 	}

+	public function BatteryGrocycodeImage(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response, array $args)
+	{
+		$size = $request->getQueryParam('size', null);
+		$gc = new Grocycode(Grocycode::BATTERY, $args['batteryId']);
+
+		if (GROCY_GROCYCODE_TYPE == '2D')
+		{
+			$png = (new DatamatrixFactory())->setCode((string) $gc)->setSize($size)->getDatamatrixPngData();
+		}
+		else
+		{
+			$png = (new BarcodeFactory())->setType('C128')->setCode((string) $gc)->setHeight($size)->getBarcodePngData();
+		}
+
+		$isDownload = $request->getQueryParam('download', false);
+		if ($isDownload)
+		{
+			$response = $response->withHeader('Content-Type', 'application/octet-stream')
+			->withHeader('Content-Disposition', 'attachment; filename=grocycode.png')
+			->withHeader('Content-Length', strlen($png))
+			->withHeader('Cache-Control', 'no-cache')
+			->withHeader('Last-Modified', gmdate('D, d M Y H:i:s') . ' GMT');
+		}
+		else
+		{
+			$response = $response->withHeader('Content-Type', 'image/png')
+			->withHeader('Content-Length', strlen($png))
+			->withHeader('Cache-Control', 'no-cache')
+			->withHeader('Last-Modified', gmdate('D, d M Y H:i:s') . ' GMT');
+		}
+		$response->getBody()->write($png);
+		return $response;
+	}
+
 	public function __construct(\DI\Container $container)
 	{
 		parent::__construct($container);
--- a/controllers/ChoresApiController.php
+++ b/controllers/ChoresApiController.php
@@ -3,6 +3,8 @@
 namespace Grocy\Controllers;

 use Grocy\Controllers\Users\User;
+use Grocy\Helpers\WebhookRunner;
+use Grocy\Helpers\Grocycode;

 class ChoresApiController extends BaseApiController
 {
@@ -108,6 +110,30 @@ class ChoresApiController extends BaseApiController
 		}
 	}

+	public function ChorePrintLabel(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response, array $args)
+	{
+		try
+		{
+			$chore = $this->getDatabase()->chores()->where('id', $args['choreId'])->fetch();
+
+			$webhookData = array_merge([
+				'chore' => $chore->name,
+				'grocycode' => (string)(new Grocycode(Grocycode::CHORE, $args['choreId'])),
+			], GROCY_LABEL_PRINTER_PARAMS);
+
+			if (GROCY_LABEL_PRINTER_RUN_SERVER)
+			{
+				(new WebhookRunner())->run(GROCY_LABEL_PRINTER_WEBHOOK, $webhookData, GROCY_LABEL_PRINTER_HOOK_JSON);
+			}
+
+			return $this->ApiResponse($response, $webhookData);
+		}
+		catch (\Exception $ex)
+		{
+			return $this->GenericErrorResponse($response, $ex->getMessage());
+		}
+	}
+
 	public function __construct(\DI\Container $container)
 	{
 		parent::__construct($container);
--- a/controllers/ChoresController.php
+++ b/controllers/ChoresController.php
@@ -2,6 +2,10 @@

 namespace Grocy\Controllers;

+use Grocy\Helpers\Grocycode;
+use jucksearm\barcode\lib\BarcodeFactory;
+use jucksearm\barcode\lib\DatamatrixFactory;
+
 class ChoresController extends BaseController
 {
 	public function ChoreEditForm(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response, array $args)
@@ -59,8 +63,25 @@ class ChoresController extends BaseController

 	public function Journal(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response, array $args)
 	{
+		if (isset($request->getQueryParams()['months']) && filter_var($request->getQueryParams()['months'], FILTER_VALIDATE_INT) !== false)
+		{
+			$months = $request->getQueryParams()['months'];
+			$where = "tracked_time > DATE(DATE('now', 'localtime'), '-$months months')";
+		}
+		else
+		{
+			// Default 1 year
+			$where = "tracked_time > DATE(DATE('now', 'localtime'), '-12 months')";
+		}
+
+		if (isset($request->getQueryParams()['chore']) && filter_var($request->getQueryParams()['chore'], FILTER_VALIDATE_INT) !== false)
+		{
+			$choreId = $request->getQueryParams()['chore'];
+			$where .= " AND chore_id = $choreId";
+		}
+
 		return $this->renderPage($response, 'choresjournal', [
-			'choresLog' => $this->getDatabase()->chores_log()->orderBy('tracked_time', 'DESC'),
+			'choresLog' => $this->getDatabase()->chores_log()->where($where)->orderBy('tracked_time', 'DESC'),
 			'chores' => $this->getDatabase()->chores()->where('active = 1')->orderBy('name', 'COLLATE NOCASE'),
 			'users' => $this->getDatabase()->users()->orderBy('username'),
 			'userfields' => $this->getUserfieldsService()->GetFields('chores_log'),
@@ -92,6 +113,40 @@ class ChoresController extends BaseController
 		]);
 	}

+	public function ChoreGrocycodeImage(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response, array $args)
+	{
+		$size = $request->getQueryParam('size', null);
+		$gc = new Grocycode(Grocycode::CHORE, $args['choreId']);
+
+		if (GROCY_GROCYCODE_TYPE == '2D')
+		{
+			$png = (new DatamatrixFactory())->setCode((string) $gc)->setSize($size)->getDatamatrixPngData();
+		}
+		else
+		{
+			$png = (new BarcodeFactory())->setType('C128')->setCode((string) $gc)->setHeight($size)->getBarcodePngData();
+		}
+
+		$isDownload = $request->getQueryParam('download', false);
+		if ($isDownload)
+		{
+			$response = $response->withHeader('Content-Type', 'application/octet-stream')
+			->withHeader('Content-Disposition', 'attachment; filename=grocycode.png')
+			->withHeader('Content-Length', strlen($png))
+			->withHeader('Cache-Control', 'no-cache')
+			->withHeader('Last-Modified', gmdate('D, d M Y H:i:s') . ' GMT');
+		}
+		else
+		{
+			$response = $response->withHeader('Content-Type', 'image/png')
+			->withHeader('Content-Length', strlen($png))
+			->withHeader('Cache-Control', 'no-cache')
+			->withHeader('Last-Modified', gmdate('D, d M Y H:i:s') . ' GMT');
+		}
+		$response->getBody()->write($png);
+		return $response;
+	}
+
 	public function __construct(\DI\Container $container)
 	{
 		parent::__construct($container);
--- a/controllers/RecipesApiController.php
+++ b/controllers/RecipesApiController.php
@@ -63,6 +63,20 @@ class RecipesApiController extends BaseApiController
 		}
 	}

+	public function CopyRecipe(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response, array $args)
+	{
+		try
+		{
+			return $this->ApiResponse($response, [
+				'created_object_id' => $this->getRecipesService()->CopyRecipe($args['recipeId'])
+			]);
+		}
+		catch (\Exception $ex)
+		{
+			return $this->GenericErrorResponse($response, $ex->getMessage());
+		}
+	}
+
 	public function __construct(\DI\Container $container)
 	{
 		parent::__construct($container);
--- a/controllers/StockApiController.php
+++ b/controllers/StockApiController.php
@@ -620,42 +620,56 @@ class StockApiController extends BaseApiController

 	public function ProductPrintLabel(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response, array $args)
 	{
-		$product = $this->getDatabase()->products()->where('id', $args['productId'])->fetch();
-
-		$webhookData = array_merge([
-			'product' => $product->name,
-			'grocycode' => (string)(new Grocycode(Grocycode::PRODUCT, $product->id)),
-		], GROCY_LABEL_PRINTER_PARAMS);
-
-		if (GROCY_LABEL_PRINTER_RUN_SERVER)
+		try
 		{
-			(new WebhookRunner())->run(GROCY_LABEL_PRINTER_WEBHOOK, $webhookData, GROCY_LABEL_PRINTER_HOOK_JSON);
-		}
+			$product = $this->getDatabase()->products()->where('id', $args['productId'])->fetch();

-		return $this->ApiResponse($response, $webhookData);
+			$webhookData = array_merge([
+				'product' => $product->name,
+				'grocycode' => (string)(new Grocycode(Grocycode::PRODUCT, $product->id)),
+			], GROCY_LABEL_PRINTER_PARAMS);
+
+			if (GROCY_LABEL_PRINTER_RUN_SERVER)
+			{
+				(new WebhookRunner())->run(GROCY_LABEL_PRINTER_WEBHOOK, $webhookData, GROCY_LABEL_PRINTER_HOOK_JSON);
+			}
+
+			return $this->ApiResponse($response, $webhookData);
+		}
+		catch (\Exception $ex)
+		{
+			return $this->GenericErrorResponse($response, $ex->getMessage());
+		}
 	}

 	public function StockEntryPrintLabel(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response, array $args)
 	{
-		$stockEntry = $this->getDatabase()->stock()->where('id', $args['entryId'])->fetch();
-		$product = $this->getDatabase()->products()->where('id', $stockEntry->product_id)->fetch();
-
-		$webhookData = array_merge([
-			'product' => $product->name,
-			'grocycode' => (string)(new Grocycode(Grocycode::PRODUCT, $stockEntry->product_id, [$stockEntry->stock_id])),
-		], GROCY_LABEL_PRINTER_PARAMS);
-
-		if (GROCY_FEATURE_FLAG_STOCK_BEST_BEFORE_DATE_TRACKING)
+		try
 		{
-			$webhookData['duedate'] = $this->getLocalizationService()->__t('DD') . ': ' . $stockEntry->best_before_date;
-		}
+			$stockEntry = $this->getDatabase()->stock()->where('id', $args['entryId'])->fetch();
+			$product = $this->getDatabase()->products()->where('id', $stockEntry->product_id)->fetch();

-		if (GROCY_LABEL_PRINTER_RUN_SERVER)
+			$webhookData = array_merge([
+				'product' => $product->name,
+				'grocycode' => (string)(new Grocycode(Grocycode::PRODUCT, $stockEntry->product_id, [$stockEntry->stock_id])),
+			], GROCY_LABEL_PRINTER_PARAMS);
+
+			if (GROCY_FEATURE_FLAG_STOCK_BEST_BEFORE_DATE_TRACKING)
+			{
+				$webhookData['due_date'] = $this->getLocalizationService()->__t('DD') . ': ' . $stockEntry->best_before_date;
+			}
+
+			if (GROCY_LABEL_PRINTER_RUN_SERVER)
+			{
+				(new WebhookRunner())->run(GROCY_LABEL_PRINTER_WEBHOOK, $webhookData, GROCY_LABEL_PRINTER_HOOK_JSON);
+			}
+
+			return $this->ApiResponse($response, $webhookData);
+		}
+		catch (\Exception $ex)
 		{
-			(new WebhookRunner())->run(GROCY_LABEL_PRINTER_WEBHOOK, $webhookData, GROCY_LABEL_PRINTER_HOOK_JSON);
+			return $this->GenericErrorResponse($response, $ex->getMessage());
 		}
-
-		return $this->ApiResponse($response, $webhookData);
 	}

 	public function RemoveProductFromShoppingList(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response, array $args)
--- a/controllers/StockController.php
+++ b/controllers/StockController.php
@@ -35,10 +35,27 @@ class StockController extends BaseController

 	public function Journal(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response, array $args)
 	{
+		if (isset($request->getQueryParams()['months']) && filter_var($request->getQueryParams()['months'], FILTER_VALIDATE_INT) !== false)
+		{
+			$months = $request->getQueryParams()['months'];
+			$where = "row_created_timestamp > DATE(DATE('now', 'localtime'), '-$months months')";
+		}
+		else
+		{
+			// Default 6 months
+			$where = "row_created_timestamp > DATE(DATE('now', 'localtime'), '-6 months')";
+		}
+
+		if (isset($request->getQueryParams()['product']) && filter_var($request->getQueryParams()['product'], FILTER_VALIDATE_INT) !== false)
+		{
+			$productId = $request->getQueryParams()['product'];
+			$where .= " AND product_id = $productId";
+		}
+
 		$usersService = $this->getUsersService();

 		return $this->renderPage($response, 'stockjournal', [
-			'stockLog' => $this->getDatabase()->uihelper_stock_journal()->orderBy('row_created_timestamp', 'DESC'),
+			'stockLog' => $this->getDatabase()->uihelper_stock_journal()->where($where)->orderBy('row_created_timestamp', 'DESC'),
 			'products' => $this->getDatabase()->products()->where('active = 1')->orderBy('name', 'COLLATE NOCASE'),
 			'locations' => $this->getDatabase()->locations()->orderBy('name', 'COLLATE NOCASE'),
 			'users' => $usersService->GetUsersAsDto(),
@@ -176,9 +193,7 @@ class StockController extends BaseController
 	public function ProductGrocycodeImage(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response, array $args)
 	{
 		$size = $request->getQueryParam('size', null);
-		$product = $this->getDatabase()->products($args['productId']);
-
-		$gc = new Grocycode(Grocycode::PRODUCT, $product->id);
+		$gc = new Grocycode(Grocycode::PRODUCT, $args['productId']);

 		if (GROCY_GROCYCODE_TYPE == '2D')
 		{
@@ -190,7 +205,6 @@ class StockController extends BaseController
 		}

 		$isDownload = $request->getQueryParam('download', false);
-
 		if ($isDownload)
 		{
 			$response = $response->withHeader('Content-Type', 'application/octet-stream')
@@ -489,7 +503,6 @@ class StockController extends BaseController
 		}

 		$isDownload = $request->getQueryParam('download', false);
-
 		if ($isDownload)
 		{
 			$response = $response->withHeader('Content-Type', 'application/octet-stream')