From 30730af374caf5dfd39a1aac2b53d803f3d4be40 Mon Sep 17 00:00:00 2001
From: Bill Erickson <berickxx@gmail.com>
Date: Thu, 20 Aug 2020 15:04:24 -0400
Subject: [PATCH] LP1889628 SIP patron username logging config option

Adds an option to oils_sip.xml which allows admins to activate (or not)
the login-via-username SIP support.

Signed-off-by: Bill Erickson <berickxx@gmail.com>
---
 Open-ILS/examples/oils_sip.xml.example                      |  8 ++++++++
 Open-ILS/src/perlmods/lib/OpenILS/SIP.pm                    | 13 +++++++++----
 docs/RELEASE_NOTES_NEXT/SIP/allow_usrname_in_patron_id.adoc |  9 +++++++++
 3 files changed, 26 insertions(+), 4 deletions(-)

diff --git a/Open-ILS/examples/oils_sip.xml.example b/Open-ILS/examples/oils_sip.xml.example
index f0edf8897b..9b191eda63 100644
--- a/Open-ILS/examples/oils_sip.xml.example
+++ b/Open-ILS/examples/oils_sip.xml.example
@@ -163,6 +163,14 @@
 					<option name='patron_status_always_permit_loans' value='false' />
 					-->
 
+					<!--
+						Allow patrons to connect to SIP services using their
+						username in addition to their barcode.  See the
+						org unit setting 'opac.barcode_regex' for configuring
+						what constitutes a barcode vs a username.
+					<option name='support_patron_username_login' value='false' />
+					-->
+
 				</options>
 
                 <checkin_override>
diff --git a/Open-ILS/src/perlmods/lib/OpenILS/SIP.pm b/Open-ILS/src/perlmods/lib/OpenILS/SIP.pm
index c1c7a764c0..693d56243d 100644
--- a/Open-ILS/src/perlmods/lib/OpenILS/SIP.pm
+++ b/Open-ILS/src/perlmods/lib/OpenILS/SIP.pm
@@ -272,10 +272,15 @@ sub find_patron {
     my $key  =  (@_ > 1) ? shift : 'barcode';  # if we have multiple args, the first is the key index (default barcode)
     my $patron_id = shift;
 
-    # Check for usrname or barcode in the same, simple way that the OPAC does.
-    my $bc_regex = $self->get_barcode_regex();
-    if ($key eq 'barcode' && $patron_id !~ /$bc_regex/) {
-        $key = 'usrname';
+    my $use_username = 
+        $self->get_option_value('support_patron_username_login') || '';
+
+    if (to_bool($use_username)) {
+        # Check for usrname or barcode in the same, simple way that the OPAC does.
+        my $bc_regex = $self->get_barcode_regex();
+        if ($key eq 'barcode' && $patron_id !~ /$bc_regex/) {
+            $key = 'usrname';
+        }
     }
 
     $self->verify_session;
diff --git a/docs/RELEASE_NOTES_NEXT/SIP/allow_usrname_in_patron_id.adoc b/docs/RELEASE_NOTES_NEXT/SIP/allow_usrname_in_patron_id.adoc
index 671bf9d586..209f22f490 100644
--- a/docs/RELEASE_NOTES_NEXT/SIP/allow_usrname_in_patron_id.adoc
+++ b/docs/RELEASE_NOTES_NEXT/SIP/allow_usrname_in_patron_id.adoc
@@ -11,3 +11,12 @@ barcode or username by comparing the field value against the
 `opac.barcode_regex` setting for the organizational unit of the logged
 in SIP2 account as configured in the oils_sip.xml file.  This is
 similar to what the OPAC does when a patron logs in.
+
+This feature requires activation.  To activate, uncomment (or add) the
+following line in the oils_sip.xml configuration file and change the 
+value from 'false' to 'true'.
+
+[source,xml]
+---------------------------------------------------------------------------
+<option name='support_patron_username_login' value='true' />
+---------------------------------------------------------------------------
-- 
2.11.0