From 01aa516be0861619b8d73af542b51d22fdc18b0d Mon Sep 17 00:00:00 2001 From: Jason Stephenson Date: Sat, 7 Jan 2017 19:49:12 -0500 Subject: [PATCH] LP 1542495: Release Notes and Sample Config Change. In addition to adding the release note file, we alter the location of the encoding element in oils_sip.xml.example to the new, recommended location. Signed-off-by: Jason Stephenson Signed-off-by: Martha Driscoll Signed-off-by: Galen Charlton --- Open-ILS/examples/oils_sip.xml.example | 22 ++++++------ .../LP1542495-Requires-SIPServer-Upgrade.adoc | 34 +++++++++++++++++++ 2 files changed, 45 insertions(+), 11 deletions(-) create mode 100644 docs/RELEASE_NOTES_NEXT/SIP/LP1542495-Requires-SIPServer-Upgrade.adoc diff --git a/Open-ILS/examples/oils_sip.xml.example b/Open-ILS/examples/oils_sip.xml.example index c3843e39c2..57ebda4596 100644 --- a/Open-ILS/examples/oils_sip.xml.example +++ b/Open-ILS/examples/oils_sip.xml.example @@ -53,22 +53,22 @@ timeout="600" retries="3"/> + + + + + + + + + + ascii + SYSCONFDIR/opensrf_core.xml USD - - - - - - - - - - ascii - diff --git a/docs/RELEASE_NOTES_NEXT/SIP/LP1542495-Requires-SIPServer-Upgrade.adoc b/docs/RELEASE_NOTES_NEXT/SIP/LP1542495-Requires-SIPServer-Upgrade.adoc new file mode 100644 index 0000000000..2b40037d8e --- /dev/null +++ b/docs/RELEASE_NOTES_NEXT/SIP/LP1542495-Requires-SIPServer-Upgrade.adoc @@ -0,0 +1,34 @@ +SIP Bugfix Requires SIPServer Upgrade +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can +crash" requires that you also upgrade SIPServer with the fix for +Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause +SIP client problems." This means that if you use SIP2 with Evergreen, +you must also upgrade SIPServer to the latest commit in the git +repository. Conversely, if you upgrade SIPServer to the latest commit +in git, you must also upgrade Evergreen or, at least, apply the patch +for Launchpad Bug 1542495. These two patches are complementary and +cannot be applied independently of one another. + +SIP Bugfix Changes How Encoding Is Determined in Configuration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The combined fix for the above mentioned SIP bugs alters the way that +the output encoding is looked up in the configuration file (typically +oils_sip.xml). SIPServer now looks for the encoding in the following +places: + +1. An +encoding+ attribute on the +account+ element for the currently active SIP account. +2. The +encoding+ element that is a child of the +insitution+ element of the currently acctive SIP account. +3. The +encoding+ element that is a child of the +implementation_config+ element that is itself a child of the +insitution+ element of the currently acctive SIP account. +4. If none of the above exist, then ASCII encoding is used by default. + +Number 3 is provided to ease the transition to the new code. It is +the current location of the +encoding+ element in the sample +configuration file and as such, where it is likely to be found in +actual files. It is recommended that you alter your configuration to +move this element out of the +implementation_config+ element and into +its parent +institution+ element. SIPServer should *not* look into +the implementation config, and this check may be removed at some time +in the future. -- 2.43.2