Derefrence fixed fields in handle_fee_paid

Properly dereference fixed fields in handle_fee_paid so that the ILS layer receives fixed fields fee type, payment type, currency type

Fixes LP 1015227

Signed-off-by: Jeff Godin <jgodin@tadl.org>
Signed-off-by: Galen Charlton <gmc@esilibrary.com>

Return proper renewal OK field on checkout fail

This will allow (hopefully) the self check to know that a renewal was
attempted on checkout failure (if the flag is set).

Signed-off-by: Thomas Berezansky <tsbere@mvlc.org>

Support "chargeable loans" via SIP2.

Pass FID_FEE_ACK to checkout message in MsgType.pm.

Also return fee info when checkout fails, so patron can
acknowledge the fee.

Signed-off-by: Jason Stephenson <jstephenson@mvlc.org>
Signed-off-by: Bill Erickson <berick@esilibrary.com>

Replace failing unit tests with 17 valid checkout tests

These 17 checkout tests came from a 3M Vseries checkout running with the
UTF8 encoding set.

Signed-off-by: Dan Scott <dscott@laurentian.ca>
Signed-off-by: Jason Stephenson <jstephenson@mvlc.org>

AZ field also needs to be in the output message.

Signed-off-by: Jason Stephenson <jstephenson@mvlc.org>
Signed-off-by: Dan Scott <dan@coffeecode.net>

Checksum calc needs to include the 'AZ' portion

Signed-off-by: Dan Scott <dscott@laurentian.ca>
Signed-off-by: Jason Stephenson <jstephenson@mvlc.org>

Convert checksum to hex value inside checksum() function

Rather than returning the integer value of the checksum and converting
that to a hex value only when it is appended to the returned message,
return the hex value from checksum() itself. This enables the unit tests
for Sip::Checksum to be run meaningfully.

Signed-off-by: Dan Scott <dan@coffeecode.net>

Restore Unicode checksum algorithm

This checksum algorithm was verified to work with
3M V-series self-check machines running with encoding
Unicode, which is important to sites with large
collections of non-English materials.

Signed-off-by: Dan Scott <dscott@laurentian.ca>

encode to UTF8 consistently

In read_SIP_packet(), we decode the incoming packet as UTF8 and then
encode it again before writing to the log, but not before returning the
message. We were instead encoding the incoming message in a subsequent
call, which is not the recommended Perl practice of decoding input and
encoding output.

Signed-off-by: Dan Scott <dscott@laurentian.ca>

Prevent corruption of SIP messages in logs

Non-ASCII characters were not being decoded before being
written to the logs, thus resulting in heinous corruption
in the logs. decode_utf8() is our friend.

Signed-off-by: Dan Scott <dscott@laurentian.ca>
Signed-off-by: Thomas Berezansky <tsbere@mvlc.org>

Item extra ILS-defined fields

Signed-off-by: Thomas Berezansky <tsbere@mvlc.org>

Support ILS-defined extension fields

Signed-off-by: Thomas Berezansky <tsbere@mvlc.org>

Restore the debug code that was deleted in a previous commit,
per Joe Atzberger's suggestion.

Signed-off-by: Jason Stephenson <jstephenson@mvlc.org>

Fix the properties of the Fee Paid message in MsgType.pm so that
the server actually parses the messages.

Signed-off-by: Jason Stephenson <jstephenson@mvlc.org>

Fix checksum generation so that it actually works with clients.

Signed-off-by: Jason Stephenson <jstephenson@mvlc.org>

Check for sip_expire before trying to use it.

Signed-off-by: Thomas Berezansky <tsbere@mvlc.org>

Add FID_PATRON_EXPIRE where required for export.

Patron Expiration in PA

Signed-off-by: Thomas Berezansky <tsbere@mvlc.org>

Allow whitespace "lines" to be skipped during login

This keeps clients who might have bad line-endings in the game.
In particular, this would help systems where an expect-driven login
process might be different than the rest of the client interaction.

Die if no listeners in config, give better log messages

Also tighten debug messages: one warning at the end listing all failed is good enough.
Certainly better than just throwaway debug messages listing what we are going to try.
Otherwise if we succeeded, we don't need to know about the ones that failed, just
report the successful one.

Perltidy and cleanup.

VERSIONing, it's good for you.

Extension for exposing patron internal ID via Patron Information

Used by some AMH systems

Spec compliance on line-endings

\r not CRLF

An extra test from CASSIE

Note: checksumming is still NOT recommendedl

Adjust comment

Item Info extensions and general cleanup

Cleanup and adjustment

bad_barcode is is better than berick for clarity.

Update to current default EG values.

Startup and shutdown scripts

Adapted from the versions I wrote for Koha SIP

Perltidy/whitespace cleanup

Tiny comment

Disable checksums in tests

Holds test disabled by default (for evergreen)

Propagate $inst_id to checkout handler

Needed for holds routing logic

At least attempt to use the same formatting....

Catch undef parameter (avoid warning/failure on substr)

Use common vars from SIPtest (stop hardcoding individual tests)

Whitespace and stylistic cleanup only.

Use more of SIPtest.pm exported values, avoid hardcoding

Not an Exporter and not implemented

Avoid undef warning, provide lanuage failover to 000 (unknown/default)

Pure stylistic and whitespace changes

Failover to language '000' (unknown/default)

Tighter indent

Executable python script

Checksum computation overhaul

This adds advanced debugging of checksum computation.

Note: good sample data is lacking.  I think most of the actual
checksum lines included in the test are questionable.  The only
one that computes accurately seems to be the example from the
3M SIP Developers Guide that specifically addresses checksum
computation.  The others from the same guide seem invalid!

I think the debugging output suggests the implementation is
consistent with the specified instructions, despite unavailability
of sample data to confirm.

Debug output capability

whitespace cleanup

Extra read_it catches telnet confirmation prompt

Tests are executable

Robust string cleaning and flexible CRLF from Socket

Simple test showing telnet vs. RAW handling.

Cleanup and more paranoid whitespace filtering

Kill useless sub _count_tests

Correct log message: Sip::MsgType::_initialize

not Sip::MsgType:_initialize (one colon)

Get rid of weird evals, useless use's

There are no scripts committed that use DATA handles, so those
eval blocks are not part of a known application.  And that
behavior is super sketchy, especially with multiple scripts, likely
in combination!

LOG_ERROR is not a valid loglevel.

LOG_ERR is.

Append extensions fields to checkin response

Add back FID_HOME_LIBRARY

Patron password is a required field

Alert type is part of the checkin extensions

Add 3M extension constants and structuralize EXPORT_TAGS

LOG_WARN is not a valid syslog loglevel

LOG_WARNING is.

Proper id (copy/paste error)

Script should be executable.

Alarm messages that mean something.

Additional log messages, or log message content borrowed from my work on Koha.
Also some blasts of perltidy.

Allow log ident string to be pulled from ENV

This supports running multiple SIP interfaces on the same box,
even as the same user.

Initial Commit

From openncip.cvs.sourceforge.net:/cvsroot/openncip
.gitignore added

Dan Scott's patch:

Item status response 18 was returning CJ0|CM0| which are invalid
according to the SIP2 specification; they should either be
18-char fixed fields or not there at all (as they're optional).

It looks like it was just a reversed test. In looking through
Sip/MsgType.pm in that area, I put together a patch which
prevents those fields from being generated if the incoming value
is 0 - and separates out the value assignment & test into
separate statements, which should make the code a bit easier to
read.

As an aside, I believe the same problem was preventing the due
date (AH) from being returned in the item status response.

Minor fix to UTF8 support

Various utf8 fixes

Restore the byte-by-byte checksum method, since the Unicode-aware
version breaks with very new 3M self-check units, according to dbs.

Fix missing parens in hash dereference

Log incoming connections promptly

Only try to strip off the leading newline if there's actually
content in the record at all (eliminate perl 'Use of
uninitialized value' warning).

Untested fix for dealing with the incorrect record terminators
transmitted by Cen-Tec self-check hardware.

Handle various dates associated with items consistently.

Add copyright statements

Update dependencies

Add support for PINES requested extension: Patron Info Response
now includes AQ "Home Library" field.

Add support for "home_library" field in patron database

Check the protocol of the client connection properly.

Clean up field parsing so it's more perlish and less C-ish

Force the key to the 'listeners' hash to be all lowercase, and
force the key for which we search at runtime to be lowercase, so
that searches of the hash are case-insensitive.

Fix code so that it will run with Net::Server 0.96.  This is just
eliminating a dependency on the internals of the Net::Server
object, so this code will continue to run with older versions of
Net::Server as well.

Apply Bill Erickson's patch to clean up matching an incoming
connection against the configuration file.  There's no longer a
special case for 127.0.0.1, so it will not longer match
'localhost', but it doesn't match any other hostnames anyway.

Move code that connects to ILS back end out of
sip_protocol_loop() and into handle_login().  This way, if
there's a problem loading or initializing the ILS implementation,
the client will be told that login failed, rather than
"successfully" logging in and then having the server die later.

Test logging in with invalid username and invalid password

Log both raw input and raw output messages.

Zero-pad the checksum that we transmit.

Cope with trailing whitespace on the titles returned from the
ILS, since that seems to be a problem for PINES

Properly transmit the patron's fee amount and currency.  Make a
note of the missing limit fields until the OPAC supports them.

Tighten up test for value of the BX field in the ACS status message

Added missing value for whether the server supports the SC/ACS
resend messages.

Transmit screen message and print line in Patron Information
Response messages.

Go back to using unpack to generate the checksums, except that
I'm using the 'U'TF encoding instead of the 'C'har encoding.
This seems to work, at least in my test environment.

Add test case for checking titles that have a diacritical in the title.

Add entry to "catalogue" that has a diacritical in the title, for
testing the checksum algorithm.

Replace idiomatic perl checksum code, which seems to fail on
strings with diacriticals in them, with an explicit sum of the
ordinal values of the characters in the string, which seems to cope.

Make two shut down messages different, to simplify debugging

Use correct boolean format for 'OK' field of Checkin Response
message.

Don't rely on clients sending the exactly protocol strings '1.00'
and '2.00'.  Anything that starts with a '1.' is a "revision 1"
protocol string and anything that begins with a '2.' is a
"revision 2" protocol string.  That way, when a clients reports
that they support protocol revision '2.0S', we will properly
react and send revision 2.00 messages.