Attachment 135258 Details for Bug 30409 – Bug 30409: barcodedecode() should always trim barcode

[patch] Bug 30409: barcodedecode() should always trim barcode

Bug-30409-barcodedecode-should-always-trim-barcode.patch (text/plain), 4.48 KB, created by Peter Vashchuk on 2022-05-23 10:20:15 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Peter Vashchuk

Created: 2022-05-23 10:20:15 UTC

Size: 4.48 KB

patch

obsolete

>From 8fc2f7f63fe6b4471f847572acb4c45df3829b56 Mon Sep 17 00:00:00 2001
>From: Petro Vashchuk <stalkernoid@gmail.com>
>Date: Sun, 3 Apr 2022 00:02:40 +0300
>Subject: [PATCH] Bug 30409: barcodedecode() should always trim barcode
>
>Barcode is trimmed of leading/trailing whitespaces in many instances
>before the barcodedecode sub was called. This patch instead makes that
>barcodedecode sub is going to trim it itself and removes unnecessary,
>and repetitive code that was used before barcodedecode was called.
>
>Steps to test:
>1. Edit item with any barcode, add a bunch of whitespaces at the start
>and at the bottom of it. Save the item. Ensure that this action ruins
>the barcode and ensure that the spaces are still there by editing the
>same item again.
>2. Apply the patch.
>3. Edit the same item again in the same fashion. Ensure that now all
>whitespaces are getting trimmed and it doesn't affect the barcode in
>any negative way.
>---
> C4/Circulation.pm                                               | 2 ++
> circ/circulation.pl                                             | 1 -
> circ/renew.pl                                                   | 1 -
> circ/returns.pl                                                 | 1 -
> .../prog/en/modules/admin/preferences/circulation.pref          | 2 +-
> 5 files changed, 3 insertions(+), 4 deletions(-)
>
>diff --git a/C4/Circulation.pm b/C4/Circulation.pm
>index d92cdcc0b2..71b549b6e3 100644
>--- a/C4/Circulation.pm
>+++ b/C4/Circulation.pm
>@@ -154,6 +154,7 @@ Will do some manipulation of the barcode for systems that deliver a barcode
> to circulation.pl that differs from the barcode stored for the item.
> For proper functioning of this filter, calling the function on the 
> correct barcode string (items.barcode) should return an unaltered barcode.
>+Barcode is going to be automatically trimmed of leading/trailing whitespaces.
> 
> The optional $filter argument is to allow for testing or explicit 
> behavior that ignores the System Pref.  Valid values are the same as the 
>@@ -167,6 +168,7 @@ System Pref options.
> sub barcodedecode {
>     my ($barcode, $filter) = @_;
>     my $branch = C4::Context::mybranch();
>+    $barcode =~ s/^\s+|\s+$//g;
>     $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
>     Koha::Plugins->call('item_barcode_transform',  \$barcode );
>     $filter or return $barcode;     # ensure filter is defined, else return untouched barcode
>diff --git a/circ/circulation.pl b/circ/circulation.pl
>index 6aaf831ba6..d7f51e44ef 100755
>--- a/circ/circulation.pl
>+++ b/circ/circulation.pl
>@@ -158,7 +158,6 @@ if (C4::Context->preference("DisplayClearScreenButton")) {
> }
> 
> for my $barcode ( @$barcodes ) {
>-    $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
>     $barcode = barcodedecode( $barcode ) if $barcode;
> }
> 
>diff --git a/circ/renew.pl b/circ/renew.pl
>index 5a1ca18ef8..e3e526a4d8 100755
>--- a/circ/renew.pl
>+++ b/circ/renew.pl
>@@ -43,7 +43,6 @@ my $schema = Koha::Database->new()->schema();
> 
> my $barcode        = $cgi->param('barcode') // '';
> my $unseen         = $cgi->param('unseen') || 0;
>-$barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespae
> $barcode = barcodedecode($barcode) if $barcode;
> my $override_limit = $cgi->param('override_limit');
> my $override_holds = $cgi->param('override_holds');
>diff --git a/circ/returns.pl b/circ/returns.pl
>index e2d2317a37..c421a231dd 100755
>--- a/circ/returns.pl
>+++ b/circ/returns.pl
>@@ -119,7 +119,6 @@ foreach ( $query->param ) {
>     $counter++;
> 
>     # decode barcode    ## Didn't we already decode them before passing them back last time??
>-    $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
>     $barcode = barcodedecode($barcode) if $barcode;
> 
>     ######################
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/circulation.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/circulation.pref
>index 6810f251c5..1c85fd8159 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/circulation.pref
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/circulation.pref
>@@ -35,7 +35,7 @@ Circulation:
>                   T-prefix: Remove the first number from T-prefix style
>                   libsuite8: Convert from Libsuite8 form
>                   EAN13: EAN-13 or zero-padded UPC-A form
>-            - scanned item barcodes.
>+            - scanned item barcodes. Mind that barcode whitespaces always trimmed from both ends before this filter.
>         -
>             - pref: itemBarcodeFallbackSearch
>               choices:
>-- 
>2.35.3

Actions: View | Diff | Splinter Review

Attachments on bug 30409: 132693 | 132781 | 132881 | 132884 | 132885 | 135258 | 135448 | 135453 | 135705 | 135731 | 135961 | 135962 | 136067