From 14eb352895f6b01ecd09d7b17d1b50391a1b2510 Mon Sep 17 00:00:00 2001
From: Galen Charlton <gmc@esilibrary.com>
Date: Mon, 7 Jul 2014 12:55:05 -0700
Subject: [PATCH] LP#1338761: add support for Relais extensions to message 24

The Relais SIP2 client expects that the Patron Status Response
(msg 24) will contain certain non-standard fields that are more
properly included in the patron information response:

- patron home address
- patron email
- patron home phone

In addition, and contrary to the specification, Relais expects that
the variable fields in the response will be given in the order that
they appear in the spec.

This patch ensures that the Patron Status repsonse emits the
institution ID, patron ID, and personal name in that order.  It also
adds a new institution option, relais_extensions_to_msg24, to make
the response includes the additional fields.  For example:

  <relais_extensions_to_msg24 enabled="true" />

Signed-off-by: Galen Charlton <gmc@esilibrary.com>
---
 SIPconfig.xml                    |  1 +
 Sip/Configuration/Institution.pm |  8 ++++++++
 Sip/MsgType.pm                   | 21 +++++++++++++++------
 3 files changed, 24 insertions(+), 6 deletions(-)

diff --git a/SIPconfig.xml b/SIPconfig.xml
index 873f074..f9e3cf3 100644
--- a/SIPconfig.xml
+++ b/SIPconfig.xml
@@ -70,6 +70,7 @@
 	  	  status_update="false" offline="false"
 		  timeout="600"
 	  	  retries="3" />
+          <relais_extensions_to_msg24 enabled="false" />
     </institution>
 
     <institution id="LPL" implementation="ILS">
diff --git a/Sip/Configuration/Institution.pm b/Sip/Configuration/Institution.pm
index de77e6f..56360ef 100644
--- a/Sip/Configuration/Institution.pm
+++ b/Sip/Configuration/Institution.pm
@@ -39,4 +39,12 @@ sub name {
     return $self->{name};
 }
 
+sub relais_extensions_to_msg24 {
+    my $self = shift;
+    return (
+        exists $self->{'relais_extensions_to_msg24'} &&
+        $self->{'relais_extensions_to_msg24'}->{'enabled'} =~ /true|yes|enabled/i
+    ) ? 1 : 0;
+}
+
 1;
diff --git a/Sip/MsgType.pm b/Sip/MsgType.pm
index 657b0ef..8f50cac 100644
--- a/Sip/MsgType.pm
+++ b/Sip/MsgType.pm
@@ -443,7 +443,7 @@ sub handle {
 # information will be returned to the terminal.
 # 
 sub build_patron_status {
-    my ($patron, $lang, $fields)= @_;
+    my ($patron, $lang, $fields, $server)= @_;
     $lang ||= '000';
     my $patron_pwd = $fields->{(FID_PATRON_PWD)};
     my $resp = (PATRON_STATUS_RESP);
@@ -451,17 +451,26 @@ sub build_patron_status {
     if ($patron) {
 	$resp .= patron_status_string($patron);
 	$resp .= $lang . Sip::timestamp();
-	$resp .= add_field(FID_PERSONAL_NAME, $patron->name);
 
 	# while the patron ID we got from the SC is valid, let's
 	# use the one returned from the ILS, just in case...
+	$resp .= add_field(FID_INST_ID, $fields->{(FID_INST_ID)});
 	$resp .= add_field(FID_PATRON_ID, $patron->id);
+	$resp .= add_field(FID_PERSONAL_NAME, $patron->name);
 	if ($protocol_version >= 2) {
 	    $resp .= add_field(FID_VALID_PATRON, 'Y');
 	    # Patron password is a required field.
 		$resp .= add_field(FID_VALID_PATRON_PWD, sipbool($patron->check_password($patron_pwd)));
 	    $resp .= maybe_add(FID_CURRENCY, $patron->currency);
 	    $resp .= maybe_add(FID_FEE_AMT, $patron->fee_amount);
+
+		# Relais extensions
+		if ($server->{institution}->relais_extensions_to_msg24()) {
+			$resp .= maybe_add(FID_HOME_ADDR,  $patron->address   );
+			$resp .= maybe_add(FID_EMAIL,      $patron->email_addr);
+			$resp .= maybe_add(FID_HOME_PHONE, $patron->home_phone);
+		}
+
 	}
 
 	$resp .= maybe_add(FID_SCREEN_MSG, $patron->screen_msg);
@@ -470,18 +479,18 @@ sub build_patron_status {
 	# Invalid patron id.  Report that the user has no privs.,
 	# no personal name, and is invalid (if we're using 2.00)
 	$resp .= 'YYYY' . (' ' x 10) . $lang . Sip::timestamp();
-	$resp .= add_field(FID_PERSONAL_NAME, '');
+	$resp .= add_field(FID_INST_ID, $fields->{(FID_INST_ID)});
 
 	# the patron ID is invalid, but it's a required field, so
 	# just echo it back
 	$resp .= add_field(FID_PATRON_ID, $fields->{(FID_PATRON_ID)});
+	$resp .= add_field(FID_PERSONAL_NAME, '');
 
 	if ($protocol_version >= 2) {
 	    $resp .= add_field(FID_VALID_PATRON, 'N');
 	}
     }
 
-    $resp .= add_field(FID_INST_ID, $fields->{(FID_INST_ID)});
 
     return $resp;
 }
@@ -502,7 +511,7 @@ sub handle_patron_status {
 
     $patron = $ils->find_patron($fields->{(FID_PATRON_ID)});
 
-    $resp = build_patron_status($patron, $lang, $fields);
+    $resp = build_patron_status($patron, $lang, $fields, $server);
 
     $self->write_msg($resp);
 
@@ -745,7 +754,7 @@ sub handle_block_patron {
         $patron->block($card_retained, $blocked_card_msg);
     }
 
-    $resp = build_patron_status($patron, $language, $fields);
+    $resp = build_patron_status($patron, $language, $fields, $server);
 
     $self->write_msg($resp);
     return(BLOCK_PATRON);
-- 
2.11.0