diff --git a/controllers/StockController.php b/controllers/StockController.php index dccc810e..31f6b79b 100644 --- a/controllers/StockController.php +++ b/controllers/StockController.php @@ -123,7 +123,6 @@ class StockController extends BaseController public function ProductBarcodesEditForm(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response, array $args) { $product = null; - if (isset($request->getQueryParams()['product'])) { $product = $this->getDatabase()->products($request->getQueryParams()['product']); @@ -272,7 +271,6 @@ class StockController extends BaseController public function QuantityUnitConversionEditForm(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response, array $args) { $product = null; - if (isset($request->getQueryParams()['product'])) { $product = $this->getDatabase()->products($request->getQueryParams()['product']); @@ -549,4 +547,24 @@ class StockController extends BaseController 'transactionTypes' => GetClassConstants('\Grocy\Services\StockService', 'TRANSACTION_TYPE_') ]); } + + public function QuantityUnitConversionsResolved(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response, array $args) + { + $product = null; + if (isset($request->getQueryParams()['product'])) + { + $product = $this->getDatabase()->products($request->getQueryParams()['product']); + $quantityUnitConversionsResolved = $this->getDatabase()->quantity_unit_conversions_resolved()->where('product_id', $product->id); + } + else + { + $quantityUnitConversionsResolved = $this->getDatabase()->quantity_unit_conversions_resolved()->where('product_id IS NULL'); + } + + return $this->renderPage($response, 'quantityunitconversionsresolved', [ + 'product' => $product, + 'quantityUnits' => $this->getDatabase()->quantity_units()->orderBy('name', 'COLLATE NOCASE'), + 'quantityUnitConversionsResolved' => $quantityUnitConversionsResolved + ]); + } } diff --git a/localization/strings.pot b/localization/strings.pot index 22a97a7a..ef2ace76 100644 --- a/localization/strings.pot +++ b/localization/strings.pot @@ -2341,3 +2341,12 @@ msgstr "" msgid "Clear done items" msgstr "" + +msgid "This shows all to this product directly or indirectly related quantity units and their derived conversion factors" +msgstr "" + +msgid "Show resolved conversions" +msgstr "" + +msgid "QU conversions resolved" +msgstr "" diff --git a/migrations/0203.sql b/migrations/0203.sql index df524f07..11779500 100644 --- a/migrations/0203.sql +++ b/migrations/0203.sql @@ -1,5 +1,4 @@ DROP VIEW quantity_unit_conversions_resolved; - CREATE VIEW quantity_unit_conversions_resolved AS @@ -127,7 +126,7 @@ AS ( ON s.to_qu_id = c.from_qu_id AND s.product_id IS NULL WHERE NOT EXISTS(SELECT 1 FROM conversion_factors ci WHERE ci.product_id = c.product_id AND ci.from_qu_id = s.from_qu_id AND ci.to_qu_id = s.to_qu_id) -- Do this only, if there is no product_specific conversion between the units in s - AND c.path NOT LIKE ('%/' || s.from_qu_id || '/%') + AND c.path NOT LIKE ('%/' || s.from_qu_id || '/%') UNION @@ -144,13 +143,13 @@ AS ( ON c.to_qu_id = s.from_qu_id AND s.product_id IS NULL WHERE NOT EXISTS(SELECT 1 FROM conversion_factors ci WHERE ci.product_id = c.product_id AND ci.from_qu_id = s.from_qu_id AND ci.to_qu_id = s.to_qu_id) -- Do this only, if there is no product_specific conversion between the units in s - AND c.path NOT LIKE ('%/' || s.to_qu_id || '/%') + AND c.path NOT LIKE ('%/' || s.to_qu_id || '/%') UNION -- Fourth case: Add the default unit conversions that are reachable by a given product. -- We cannot start with them directly, as we only want to add default conversions, - -- where at least one of the units is 'reachable' from the product's storage quantity unit. + -- where at least one of the units is 'reachable' from the product's stock quantity unit. -- Thus we add these cases here. SELECT DISTINCT 1, c.product_id, @@ -159,7 +158,7 @@ AS ( s.factor FROM closure c, conversion_factors s WHERE NOT EXISTS(SELECT 1 FROM conversion_factors ci WHERE ci.product_id = c.product_id AND ci.from_qu_id = s.from_qu_id AND ci.to_qu_id = s.to_qu_id) - AND c.path LIKE ('%/' || s.from_qu_id || '/' || s.to_qu_id || '/%') + AND c.path LIKE ('%/' || s.from_qu_id || '/' || s.to_qu_id || '/%') ) SELECT DISTINCT diff --git a/migrations/0204.sql b/migrations/0204.sql new file mode 100644 index 00000000..36c18711 --- /dev/null +++ b/migrations/0204.sql @@ -0,0 +1,182 @@ +DROP VIEW quantity_unit_conversions_resolved; +CREATE VIEW quantity_unit_conversions_resolved +AS + +/* + First, determine conversions that are a single step. + There may be multiple definitions for conversions between two units + (e.g. due to purchase-to-stock, product-specific and default conversions), + thus priorities are used to disambiguate conversions. + Later, we'll only use the factor with the highest priority to convert between two units. +*/ + +WITH RECURSIVE conversion_factors_dup(product_id, from_qu_id, to_qu_id, factor, priority) +AS ( + -- Priority 1: Product "purchase to stock" factors ... + SELECT + id, + qu_id_purchase, + qu_id_stock, + qu_factor_purchase_to_stock, + 40 + FROM products + WHERE qu_id_stock != qu_id_purchase + UNION -- ... and the inverse factors + SELECT + id, + qu_id_stock, + qu_id_purchase, + 1.0 / qu_factor_purchase_to_stock, + 40 + FROM products + WHERE qu_id_stock != qu_id_purchase + + UNION + + -- Priority 2: Product specific QU overrides + -- Note that the quantity_unit_conversions table already contains both conversion directions for every conversion. + SELECT + product_id, + from_qu_id, + to_qu_id, + factor, + 30 + FROM quantity_unit_conversions + WHERE product_id IS NOT NULL + + UNION + + -- Priority 3: Default QU conversions are handled in a later CTE, as we can't determine yet, for which products they are applicable. + SELECT + product_id, + from_qu_id, + to_qu_id, + factor, + 20 + FROM quantity_unit_conversions + WHERE product_id IS NULL + + UNION + + -- Priority 4: QU conversions with a factor of 1.0 from the stock unit to the stock unit + SELECT + id, + qu_id_stock, + qu_id_stock, + 1.0, + 10 + FROM products +), + +-- Now, remove duplicate conversions, only retaining the entries with the highest priority +conversion_factors(product_id, from_qu_id, to_qu_id, factor) +AS ( + SELECT + product_id, + from_qu_id, + to_qu_id, + FIRST_VALUE(factor) OVER win + FROM conversion_factors_dup + GROUP BY product_id, from_qu_id, to_qu_id + WINDOW win AS(PARTITION BY product_id, from_qu_id, to_qu_id ORDER BY priority DESC) +), + +-- Now build the closure of posisble conversions using a recursive CTE +closure(depth, product_id, from_qu_id, to_qu_id, factor, path) +AS ( + -- As a base case, select the conversions that refer to a concrete product + SELECT + 1 as depth, + product_id, + from_qu_id, + to_qu_id, + factor, + '/' || from_qu_id || '/' || to_qu_id || '/' -- We need to keep track of the conversion path in order to prevent cycles + FROM conversion_factors + WHERE product_id IS NOT NULL + + UNION + + -- First recursive case: Add a product-associated conversion to the chain + SELECT + c.depth + 1, + c.product_id, + c.from_qu_id, + s.to_qu_id, + c.factor * s.factor, + c.path || s.to_qu_id || '/' + FROM closure c + JOIN conversion_factors s + ON c.product_id = s.product_id + AND c.to_qu_id = s.from_qu_id + WHERE c.path NOT LIKE ('%/' || s.to_qu_id || '/%') -- Prevent cycles + + UNION + + -- Second recursive case: Add a default unit conversion to the *start* of the conversion chain + SELECT + c.depth + 1, + c.product_id, + s.from_qu_id, + c.to_qu_id, + s.factor * c.factor, + '/' || s.from_qu_id || c.path + FROM closure c + JOIN conversion_factors s + ON s.to_qu_id = c.from_qu_id + AND s.product_id IS NULL + WHERE NOT EXISTS(SELECT 1 FROM conversion_factors ci WHERE ci.product_id = c.product_id AND ci.from_qu_id = s.from_qu_id AND ci.to_qu_id = s.to_qu_id) -- Do this only, if there is no product_specific conversion between the units in s + AND c.path NOT LIKE ('%/' || s.from_qu_id || '/%') -- Prevent cycles + + UNION + + -- Third recursive case: Add a default unit conversion to the *end* of the conversion chain + SELECT + c.depth + 1, + c.product_id, + c.from_qu_id, + s.to_qu_id, + c.factor * s.factor, + c.path || s.to_qu_id || '/' + FROM closure c + JOIN conversion_factors s + ON c.to_qu_id = s.from_qu_id + AND s.product_id IS NULL + WHERE NOT EXISTS(SELECT 1 FROM conversion_factors ci WHERE ci.product_id = c.product_id AND ci.from_qu_id = s.from_qu_id AND ci.to_qu_id = s.to_qu_id) -- Do this only, if there is no product_specific conversion between the units in s + AND c.path NOT LIKE ('%/' || s.to_qu_id || '/%') -- Prevent cycles + + UNION + + -- Fourth case: Add the default unit conversions that are reachable by a given product. + -- We cannot start with them directly, as we only want to add default conversions, + -- where at least one of the units is 'reachable' from the product's stock quantity unit. + -- Thus we add these cases here. + SELECT DISTINCT + 1, c.product_id, + s.from_qu_id, s.to_qu_id, + s.factor, + '/' || s.from_qu_id || '/' || s.to_qu_id || '/' + FROM closure c, conversion_factors s + WHERE NOT EXISTS(SELECT 1 FROM conversion_factors ci WHERE ci.product_id = c.product_id AND ci.from_qu_id = s.from_qu_id AND ci.to_qu_id = s.to_qu_id) + AND c.path LIKE ('%/' || s.from_qu_id || '/' || s.to_qu_id || '/%') -- Prevent cycles +) + +SELECT DISTINCT + -1 AS id, -- Dummy, LessQL needs an id column + c.product_id, + c.from_qu_id, + qu_from.name AS from_qu_name, + qu_from.name_plural AS from_qu_name_plural, + c.to_qu_id, + qu_to.name AS to_qu_name, + qu_to.name_plural AS to_qu_name_plural, + FIRST_VALUE(factor) OVER win AS factor, + FIRST_VALUE(c.path) OVER win AS path +FROM closure c +JOIN quantity_units qu_from + ON c.from_qu_id = qu_from.id +JOIN quantity_units qu_to + ON c.to_qu_id = qu_to.id +GROUP BY product_id, from_qu_id, to_qu_id +WINDOW win AS (PARTITION BY product_id, from_qu_id, to_qu_id ORDER BY depth ASC) +ORDER BY product_id, from_qu_id, to_qu_id; diff --git a/public/viewjs/quantityunitconversionsresolved.js b/public/viewjs/quantityunitconversionsresolved.js new file mode 100644 index 00000000..2118da63 --- /dev/null +++ b/public/viewjs/quantityunitconversionsresolved.js @@ -0,0 +1,39 @@ +var quConversionsResolvedTable = $('#qu-conversions-resolved-table').DataTable({ + 'order': [[1, 'asc']], + 'columnDefs': [ + { 'orderable': false, 'targets': 0 }, + { 'searchable': false, "targets": 0 } + ].concat($.fn.dataTable.defaults.columnDefs) +}); +$('#qu-conversions-resolved-table tbody').removeClass("d-none"); +quConversionsResolvedTable.columns.adjust().draw(); + +$("#search").on("keyup", Delay(function() +{ + var value = $(this).val(); + if (value === "all") + { + value = ""; + } + + quConversionsResolvedTable.search(value).draw(); +}, 200)); + +$("#quantity-unit-filter").on("change", function() +{ + var value = $("#quantity-unit-filter option:selected").text(); + if (value === __t("All")) + { + value = ""; + } + + quConversionsResolvedTable.column([quConversionsResolvedTable.colReorder.transpose(1), quConversionsResolvedTable.colReorder.transpose(2)]).search(value).draw(); +}); + +$("#clear-filter-button").on("click", function() +{ + $("#search").val(""); + $("#quantity-unit-filter").val("all"); + quConversionsResolvedTable.column([quConversionsResolvedTable.colReorder.transpose(1), quConversionsResolvedTable.colReorder.transpose(2)]).search("").draw(); + quConversionsResolvedTable.search("").draw(); +}); diff --git a/routes.php b/routes.php index a6ef8bbc..7e02f0b0 100644 --- a/routes.php +++ b/routes.php @@ -62,6 +62,7 @@ $app->group('', function (RouteCollectorProxy $group) { $group->get('/productbarcodes/{productBarcodeId}', '\Grocy\Controllers\StockController:ProductBarcodesEditForm'); $group->get('/stockentry/{entryId}/grocycode', '\Grocy\Controllers\StockController:StockEntryGrocycodeImage'); $group->get('/stockentry/{entryId}/label', '\Grocy\Controllers\StockController:StockEntryGrocycodeLabel'); + $group->get('/quantityunitconversionsresolved', '\Grocy\Controllers\StockController:QuantityUnitConversionsResolved'); } // Stock price tracking diff --git a/views/productform.blade.php b/views/productform.blade.php index f0e94a49..27d90ec0 100644 --- a/views/productform.blade.php +++ b/views/productform.blade.php @@ -579,7 +579,7 @@ @if($mode == "edit") diff --git a/views/quantityunitconversionsresolved.blade.php b/views/quantityunitconversionsresolved.blade.php new file mode 100644 index 00000000..863b363e --- /dev/null +++ b/views/quantityunitconversionsresolved.blade.php @@ -0,0 +1,104 @@ +@extends('layout.default') + +@section('title', $__t('QU conversions resolved')) + +@section('viewJsName', 'quantityunitconversionsresolved') + +@section('content') +
+
+
+

@yield('title')

+ @if($product != null) +

+ {{ $__t('Product') }} {{ $product->name }} +

+ @endif +
+
+
+ +
+ +
+
+
+
+ +
+ +
+
+
+
+
+  {{ $__t('Quantity unit') }} +
+ +
+
+
+
+ +
+
+
+ +
+
+ + + + + + + + + + + + + @foreach($quantityUnitConversionsResolved as $quConversion) + + + + + + + + @endforeach + +
+ {{ $__t('Quantity unit from') }}{{ $__t('Quantity unit to') }}{{ $__t('Factor') }}
+ {{ FindObjectInArrayByPropertyValue($quantityUnits, 'id', $quConversion->from_qu_id)->name }} + + {{ FindObjectInArrayByPropertyValue($quantityUnits, 'id', $quConversion->to_qu_id)->name }} + + {{ $quConversion->factor }} + + {!! $__t('This means 1 %1$s is the same as %2$s %3$s', FindObjectInArrayByPropertyValue($quantityUnits, 'id', $quConversion->from_qu_id)->name, '' . $quConversion->factor . '', $__n($quConversion->factor, FindObjectInArrayByPropertyValue($quantityUnits, 'id', $quConversion->to_qu_id)->name, FindObjectInArrayByPropertyValue($quantityUnits, 'id', $quConversion->to_qu_id)->name_plural, true)) !!} +
+ +
+
+@stop