LP#1974193: fix memory leak in C apps

This patch fixes a memory leak that can occur when
a C app does the following:

- send a non-chunked response
- add a response to a bundle to send later
- send a request complete status message

The leak could add up for long-lived C apps.

To test
-------
[1] Set a up C app such as Evergreen's open-ils.pcrud and
    send a lot of requests to it whose responses would not be
    large enough to be chunked, but not so many as to go over
    max_requests. It may be helpful to limit the service to
    just a single child.
[2] Check memory usage of the child after the requests are
    processed.
[3] Apply the patch and repeat step 1. This time, memory
    usage should be less.

Signed-off-by: Galen Charlton <gmc@equinoxOLI.org>
Signed-off-by: Jason Stephenson <jason@sigio.com>

LP#1970469: fix responses streamed out of order due to chunking

If a streaming method starts off sending a couple small responses
followed by a large one, the responses can end up received out of
order under this scenario:

- The initial small responses get stashed to be sent out as a bundle
- The large response, if big enough to require chunking, gets sent
  out as a set of partial responses. However, any messages queued
  up to go out as a bundle remain in the queue.
- When the method completes, or if further responses result in
  exceeding the maximum bundle size, the queued messages get sent
  _after_ the chunked response.

This affects services written in C and Perl.

To test
-------

C service
=========
[1] Add the following stored procedure to an Evergreen database:

CREATE OR REPLACE FUNCTION public.lp1970469_sample() RETURNS SETOF TEXT AS $$
BEGIN
    RETURN NEXT 'abc';
    RETURN NEXT 'def';
    RETURN NEXT rpad('long', 65000, 'x');
    RETURN NEXT 'xyz';
    RETURN;
END;
$$ LANGUAGE PLPGSQL IMMUTABLE;

[2] Run the following srfsh command:

srfsh# open-ils.cstore open-ils.cstore.json_query.atomic {"from":["public.lp1970469_sample"]}

[3] Note that longxxxxx* response is returned first, followed by abc,
    def, and xyz.
[4] Apply the patch and repeat step 2. This time, the responses should
    be returned in the expected order.

Perl service
============
[1] In an Evergreen database, attach a couple hundred items to
    a record.
[2] Run the following srfsh command:

srfsh# request open-ils.supercat open-ils.supercat.record.holdings_xml.retrieve BIBID, "-", null, 1

[3] If enough items were attached, the first response streamed will
    start with a <volume> element rather than the <holdings> element
    and the overall response will not be well-formed XML.
[4] Apply the patch and repeat step 2. This time, the parts of the
    response should be in the expected order.

Note that this test scenario models an Evergreen glitch seen in the
wild that causes requests for

https://EGSERVER//opac/extras/supercat/retrieve/marcxml-full/record/BIBID

to fall if there are a lot of items attached to the bib.

Signed-off-by: Galen Charlton <gmc@equinoxOLI.org>
Signed-off-by: Mike Rylander <mrylander@gmail.com>

LP#1919502 C listener backlog loop speedbump

When the request backlog contains items in the C forking code, attempts
to process the request run in a tight loop without stopping until the
backlog is once again empty.  This can lead to spewing "Could not launch
a new child" warning messages at a high rate, saturating log files.

This commit adds a 1 second speed bump between backlog processing loops
to allow time for drones to complete their task and start processing the
remaining queued requests.  The delay has a secondary affect of limited
the speed of the warning log spewing.

This 1-second speedbump logic matches that of the Perl code.

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Jeff Davis <jeff.davis@bc.libraries.coop>
Signed-off-by: Galen Charlton <gmc@equinoxOLI.org>

LP1930578: Really Stop Single Services

Use the same timeout / escalation method for single services as is
used for all services. Punted on any real refactoring for now.

Signed-off-by: Jason Boyer <JBoyer@equinoxOLI.org>
Signed-off-by: Galen Charlton <gmc@equinoxOLI.org>

LP1940146: (follow-up) remove a math_xul_client file from .gitignore

Signed-off-by: Galen Charlton <gmc@equinoxOLI.org>

LP1940146: Clarify README

Clarify Ejabberd shaper settings instructions for Debian 11, Bullseye
in the README.

Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Chris Sharp <csharp@georgialibraries.org>

Remove XUL opensrf.math Client

Signed-off-by: Jason Boyer <JBoyer@equinoxOLI.org>
Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Chris Sharp <csharp@georgialibraries.org>

LP1940146: Update documentation

Signed-off-by: Jason Boyer <JBoyer@equinoxOLI.org>
Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Chris Sharp <csharp@georgialibraries.org>

LP1940146: Debian Bullseye Installation Support

This commit also addresses LP 1940145: Remove Installation
Support for Debian Jessie. The individual distribution-specific
targets (stretch, buster, etc.) have also been removed since
they are now all the same, much like both Ubuntu targets just
call ubuntu_generic. The two generic targets have been left
in case they're necessary again in future.

Signed-off-by: Jason Boyer <JBoyer@equinoxOLI.org>
Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Chris Sharp <csharp@georgialibraries.org>

Fix LP#1883169 by using growing_buffer

When presented with an error message that has more than 32 characters
that need to be escaped, the gateway fails to reserve enough space in
the memory allocation it uses to build the JSON message.  Instead of
guessing at how much space will be needed, and failing for some
messages, this commit uses growing_buffer to build the JSON.
growing_buffer is limited to 10Mb, so while large messages could be
generated, they won't cause an OOM on the server side.

Signed-off-by: Ken Cox <kenstir@gmail.com>
Signed-off-by: Mike Rylander <mrylander@gmail.com>

Lp 1901899: Remove References to Ubuntu 16.04

Remove references to Ubuntu 16.04 Xenial Xerus in the README and
Makefile.install.

Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Ben Shum <ben@evergreener.net>

Lp 1875544: Add Installation Support for Ubuntu 20.04 Focal Fossa

Update README and install prerequisites with ubuntu-focal target.

Consolidate Ubuntu Makefile.install targets to remove redundant
"code."

Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Ben Shum <ben@evergreener.net>

LP 1827051: Remove Java Code, etc.

Java support in OpenSRF does not build and is out of date with current
OpenSRF features.  No one has the intention to fix it, so this commit
removes Java from the code, build files, and documentation.

To test that Java is indeed broken, configure OpenSRF with the
--enable-java option and then watch the make fail as it tries to pull
in missing dependencies.

To test this branch, simply apply it and see that the option to enable
Java is gone along with all of the obsolete code and build instructions.

Signed-off-by: Jason Stephenson <jason@sigio.com>

LP1827055 Remove Python libs, install bits, and docs

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Chris Sharp <csharp@georgialibraries.org>

Lp 1860068: Clarify README for Debian Buster

Indicate that the mod_legacy_auth directive is foudn in the modules
section of the ejabberd configuration (ejabberd.yml) for Debian Buster
and/or Ubuntu Bionic.

Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP1874510 libopensrf recv timeout cal repair

Fixes the message receive timeout calculation logic in OpenSRF C client
code.  The calculation is performed when multiple calls to receive are
needed to piece together a response message.

The logic previously calculated the time remaining as the time remaining
minus the total time taken for all iterations with each loop iteration,
leading to exhausting the timeout too quickly.  Now it calculates the
value as time remaining minus the time taken for the only most recent
loop iteration.

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Jason Stephenson <jason@sigio.com>

Revert "LP#1272937 Followup: Remove m4/.gitignore"

This reverts commit 67fc8a1c0a1cc66c5ecfc6d2ff1b6f17597463cb.

LP#1272937 Followup: Remove m4/.gitignore

Remove m4/.gitignore and a line to .gitignore to ignore the m4 files
in the m4 subdirectory.

Signed-off-by: Jason Stephenson <jason@sigio.com>

LP#1272937 - Quiet warnings from autoreconf -i

We change INCLUDES to AM_CPPFLAGS and change
the syntax for AM_INIT_AUTOMAKE to match current
recommendations.  Also, add an m4 directory.

Thanks to Warren Layton for direction towards these
solutions.

Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
Signed-off-by: Jason Stephenson <jason@sigio.com>

LP1830642 Remove variable args from md5sum()

Remove support for passing variable args to the md5sum() function, since
no code currently uses this, and it causes problems processing strings
with '%' characters.

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1835458: Add install support for Debian 10 Buster

Signed-off-by: Ben Shum <ben@evergreener.net>
Signed-off-by: Jason Stephenson <jason@sigio.com>

LP1834208 fix OpenSRF README asciidoc syntax

Fixing the subheading so that it compiles properly.

Signed-off-by: Ben Shum <ben@evergreener.net>

LP1834208 Rearrange proxy instructions to reduce repetition

The instructions for Apache configuration changes were repeated
multiple times throughout the README. This pulls them together,
allowing the Nginx and HAProxy sections to focus specifically on
the configuration of those packages.

Signed-off-by: Jason Boyer <jboyer@library.in.gov>
Signed-off-by: Ben Shum <ben@evergreener.net>

LP1834208 Update proxy example configuration files

The examples/haproxy/osrf-ws-http-proxy file needed a syntax
correction with the listen directive.

Remove X-Real-IP lines from the examples/nginx/osrf-ws-http-proxy
configuration, and remove the X-Client-IP line from the
examples/haproxy/osrf-ws-http-proxy configuration.  These entries are
redundant when X-Forwarded-For is being used.

This latter change also suggests changes in the Evergreen Apache 2
configuration examples.

Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Jason Boyer <jboyer@library.in.gov>
Signed-off-by: Ben Shum <ben@evergreener.net>

LP1834208 Remove example Apache Websockets configuration

The examples/apache_24/websockets files were left behind by the
previous commit.  This commit deletes them.

Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Jason Boyer <jboyer@library.in.gov>
Signed-off-by: Ben Shum <ben@evergreener.net>

LP1834208 Removing apache2-websockets

Remove code and build components for apache2-websockets.  Update
documentation to reflect the use of websocketd as the only supported
OpenSRF websockets implementation.

Add a note to the install documentation indicating websocketd does not
offer a configurable inactivity timeout, but this can be accomplished
by running it behind a proxy.

Update NGINX and HAPROXY example configs to reflect the assumption that
websocketd is runs locally without SSL by default.

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Jason Boyer <jboyer@library.in.gov>
Signed-off-by: Ben Shum <ben@evergreener.net>

LP#1824184: Change potentially slow log statements to subroutines

The OpenSRF code was searched for potentially slow logging statements at
log level info or above. We then changed those logging statements to be
delayed execution subroutines. This is in reaction to LP1823338 where a
slow debug logging statement was slowing down SIP checkins even though
debug logging was not turned on.

Here is some pseudocode that shows what is being done here:

$log->debug("Some text " . $some->slow_method);

would be changed to:

$log->debug(sub{return "Some text " . $some->slow_method });

With this change, an unnamed sub is passed to the OpenSRF logger module
and it will not be executed unless the global logging level is set to
debug or higher (the slow_method will not be called unless it is needed
for that logging level).

********
If/when this is committed, please use delayed execution subroutines for
any logging statements that could be slow in the future. It is recommend
that any logging statements that do not consist entirely of quoted text
and/or already available scalar variables use delayed execution
subroutines.
********

Testing notes
-------------
[1] This patch reduced the duration of open-ils.storage.actor.user.total_owed
    calls on a test system from an average of 0.13 seconds to an overage
    of 0.009 seconds.
[2] It didn't materially affect the duration of calls to
    open-ils.actor.user.opac.vital_stats.
[3] This make sense: open-ils.storage has far more generated methods
    than open-ils.actor.
[4] There are enough instances in Evergreen of using method_lookup to find
    routines in open-ils.storage that the speed improvement may well be
    perceptible to humans, not just SIP sorters.

Signed-off-by: John Merriam <jmerriam@biblio.org>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1824181: add test cases

To test
-------
[1] Verify that 'make check' (or prove src/perl/t/09-Utils-Logger.t)
    passes.

Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1824181: Allow 1st arg to logger to be string or subroutine

This simple change allows the $msg passed to _log_message in Logger.pm
to be either a regular string or a delayed exec subroutine. This is in
reaction to LP1823338 where a slow debug logging statement was slowing
down SIP checkins even though debug logging was not turned on.

With this change you can take this:

$log->debug("Available methods\n\t".join("\n\t", keys %{ $_METHODS[$proto] }), INTERNAL);

and change it to this:

$log->debug(sub{return "Available methods\n\t".join("\n\t", keys %{ $_METHODS[$proto] }) }, INTERNAL);

and then that slow debug logging line will not be executed unless
debug logging is turned on.

Signed-off-by: John Merriam <jmerriam@biblio.org>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

Lp 1808580: Remove Installation Support for Ubuntu 14.04

Remove references to Ubuntu 14.04 from the README and the
Makefile.install prerequisites.

Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Ben Shum <ben@evergreener.net>

LP#1729610: extend backlog queue to C apps

This patch extends the notion of a backlog queue to C apps and
offers the same functionality as the Perl side of the patch series:

- max_backlog_queue configuration setting
- ability to queue messages up to the configured limit
- ability to drop requests that would overflow the backlog
  queue and send status 503 exceptions back to the client.

This patch also adds a new service, opensrf.cslow, that implements
a opensrf.cslow.wait method similar to the Perl opensrf.slooooooow
service.

To test
-------
[1] Set a low max_backlog_queue for opensrf.cslow and a low
    max_children.
[2] Arrange for srfsh to fire off a bunch of opensrf.cslow.wait
    requests.
[3] Verify that requests that come in after the backlog queue fills
    up immediately get 503 exceptions.

Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Mike Rylander <mrylander@gmail.com>

LP#1729610: return new OpenSRF status if backlog queue fills up

This patch teaches Perl services how to return a new OpenSRF status,
OSRF_STATUS_SERVICEUNAVAILABLE (code 503) if the backlog queue
for a service gets full.

To test
-------
[1] Set a low max_backlog_queue for opensrf.sloooow and a low
    max_children.
[2] Arrange for srfsh to fire off a bunch of opensrf.sloooow.wait
    requests.
[3] Verify that requests that come in after the backlog queue fills
    up immediately get 503 exceptions.

Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Mike Rylander <mrylander@gmail.com>

LP#1729610: make it possible to set max_backlog_queue in opensrf.xml

This patch adds a new service configuration option, max_backlog_queue,
to allow controlling the size of the backlog queue.

If not otherwise specified in opensrf.xml, max_backlog_queue defaults
to 1000.

Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Mike Rylander <mrylander@gmail.com>

LP#1729610: Fix incorrect param description

Mike confirmed that the code expects "pause" to be an integer. This
commit changes the description to reflect that, and to mention the
default value.

Signed-off-by: Remington Steed <rjs7@calvin.edu>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Mike Rylander <mrylander@gmail.com>

LP#1729610: Add some debug/internal logging to backlog queue

Signed-off-by: Mike Rylander <mrylander@gmail.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Mike Rylander <mrylander@gmail.com>

LP#1729610: Add a service useful for testing behavior in slow response conditions

This service, opensrf.slooooooow, offers a opensrf.slooooooow.wait method
that waits for the number of seconds specified in its sole parameter.

Signed-off-by: Mike Rylander <mrylander@gmail.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Mike Rylander <mrylander@gmail.com>

LP#1729610: Allow queuing (for a while) during child backlog

This patch teaches OpenSRF listeners for Perl services how to maintain
a queue of requests in case no drone process is immediately available
to process a requeust.

Signed-off-by: Mike Rylander <mrylander@gmail.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Mike Rylander <mrylander@gmail.com>

LP#1803182 Websocketd graceful shutdown support

Give websocketd clients a chance to complete any requests that are
in-process at time of shutdown.

Graceful shutdown is initiated by sending a SIGUSR1 signal to the
websocket-osrf child processes or to the parent process group.

This can be done directly via:

$ kill -s USR1 -$websocketd_parent_pid

Or via systemd for systemd users:

$ sudo systemctl kill -s USR1 websocketd-osrf

Note the websocketd parent process ignores SIGUSR1.

Once initiated, the websocketd backend goes into shutdown mode polling
for a graceful shutdown window, which occurs when all request up to now
have been completed.  Once that moment arrives, the client is kicked off
and must connect to a new websocketd instance to issue any new requests.

The polling period lasts for SHUTDOWN_MAX_GRACEFUL_SECONDS seconds (in
osrf-websocket-stdio.c), which currently defaults to 2 minutes.

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1706147 Perl Force-Recycle drone option

Creates an API-level option to inform the OpenSRF drone management code
that the running drone should be recycled upon completion of the current
OpenSRF session.  This allows for quicker release of resources consumed
by the drone.

To use:

sub some_api_method {
    my ($self, $client, ...) = @_;
    $self->session->force_recycle(1);
    ...
}

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1684970 Translator compatible with mod_remoteip

Teach the OSRF Translator to request the IP address of the user agent
(e.g. web browser) instead of the IP address of the up stream client,
which may be a proxy, using the Apache 2.4 request_rec->useragent_ip
value.

http://httpd.apache.org/docs/2.4/developer/new_api_2_4.html

This make is possible for the translator to access the client IP with
Apache's mod_remoteip enabled and configured.

Includes sample config and install documentation.

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1711145 NGINX sample websocketd configs

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1711145 NGINX sample config security improvements

* Adds security recommendations from
https://mozilla.github.io/server-side-tls/ssl-config-generator/
* Enables http2
* Apply a 5-minute proxy read timeout to avoid too-short timeouts on
  long API calls.
* Adds a (commented) section on sending nginx logs to syslog

Includes INSTALL notes on generating the dhparam file.

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

Reorder Ejabberd configuration steps for Ubuntu 18.04.

Rearrange the steps for modifying /etc/ejabberd/ejabberd.yml on Ubuntu
18.04 so that they are in the same order that they appear in the file.

Signed-off-by: Jason Stephenson <jason@sigio.com>

LP#1776510 JS libs handle transport errors

Teach the websocket client code to look for the transport_error flag
applied to the websocket wrapper message by the websocket gateway when a
request for an unavilable service is made.

When encountered, fire the transport or generic error handler callbacks,
if available.  Avoid any attempts to further process the message.

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

Update README to include Bionic steps

Note the use of mod_legacy_auth in ejabberd 18.x version for Ubuntu Bionic

Signed-off-by: Ben Shum <ben@evergreener.net>
Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

Add support for Ubuntu 18.04 Bionic Beaver to Makefile.install

Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
Signed-off-by: Ben Shum <ben@evergreener.net>
Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1703411 XMPP opensrf element make check repairs

Update the transport_message unit tests to check for the new <opensrf/>
element for relaying custom commands.

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Mike Rylander <mrylander@gmail.com>

LP#1703411 XMPP opensrf sub-element repairs

* Message template typo repair -- missing "'"
* XPath repair on path to opensrf sub-element for Perl
* Move 'type' attribute get/set back up to the <message> for Perl.
* Clean up code duplication in the C message building libs.
* Squash a centuries-old memory leak where xmlFree(sender) was only
  called if a router_from was not supplied.

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Mike Rylander <mrylander@gmail.com>

LP#1703411: Move OpenSRF XMPP attrs to subelement

Modern versions of Ejabberd strip custom XML attributes which appear
outside of custom elements.  To support OpenSRF's custom router and
osrf_xid commands, move these attributes into a new custom XML element
<opensrf>.

Signed-off-by: Mike Rylander <mrylander@gmail.com>
Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Jason Stephenson <jason@sigio.com>

Lp#1718459: Remove Debian 7 Wheezy installation support.

Remove references to Debian 7 Wheezy in the README.

Remove src/extras/Makefile.install targets for Wheezy.

Remove the examples/apache2 directory, since none of the supported
distros come with Apache 2.2 any longer.

To test: Simply install on a supported distribution other than Debian
7 Wheezy and do the usual tests.

Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Ben Shum <ben@evergreener.net>

LP#1777180: Add zip/unzip to prerequisites

Need unzip for new websocketd unpackaging. Also get zip just because.

Signed-off-by: Ben Shum <ben@evergreener.net>
Signed-off-by: Jason Stephenson <jason@sigio.com>

LP#1777180 Update README for websocketd

Add optional command to run websocketd without using a proxy.

Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Ben Shum <ben@evergreener.net>

LP#1777180 Websocketd gateway and test scripts

Adds a new OpenSRF binary/program for relaying websockets messages
to and from a websocketd instance.  The new binary
(osrf-websocket-stdio) performs the same tasks as the
osrf_websocket_translator.c Apache module, minus the Apache module glue
and the extra threading required to run within the Apache module.

Commit includes 2 test scripts (tester.pl and test-stateful.pl) for
generating large series of test messages to send to a websockets
instance. tester.pl sends echo requests only, test-stateful.pl sends
connect->echo-request->disconnect batches across a configurable number
of forked processes.

INSTALL document updated to include websocketd setup as an alternative
to Apache websockets.

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Jeff Davis <jeff.davis@bc.libraries.coop>
Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Ben Shum <ben@evergreener.net>

LP#1702978: memcache Get methods use key as va_list format

And, when a key (composed of, say, a username or barcode) has a % in it,
bad things happen.  We will stop acting as if these are variadic functions
now, and also update Evergreen so that it does not do that either.

TODO: Make these actually non-variadic, but that breaks ABI.

Signed-off-by: Mike Rylander <mrylander@gmail.com>
Signed-off-by: Cesar Velez <cesar.velez@equinoxinitiative.org>
Signed-off-by: Jason Stephenson <jason@sigio.com>

LP#1243841: quiet a misleading indentation warning

Adjusts a spaces-vs-tabs issue to fix the following compilation
warning:

osrf_prefork.c: In function ‘check_children’:
osrf_prefork.c:1067:5: warning: this ‘if’ clause does not
guard... [-Wmisleading-indentation]
     if( select_ret <= 0 ) // we're done here
     ^~
osrf_prefork.c:1072:2: note: ...this statement, but the latter is
misleadingly indented as if it is guarded by the ‘if’
  cur_child = forker->first_child;
  ^~~~~~~~~

Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1243841 - Quiet remaining Make install warnings.

We silence the following warnings:

apachetools.c:179:15: warning: initialization discards 'const' qualifier
from pointer target type [enabled by default]

apachetools.c:181:8: warning: assignment discards 'const' qualifier from
pointer target type [enabled by default]

apachetools.c:183:8: warning: assignment discards 'const' qualifier from
pointer target type [enabled by default]

./osrf_websocket_translator.c:541:9: warning: return makes integer from
pointer without a cast [enabled by default]

./osrf_http_translator.c:300:25: warning: passing argument 1 of 'free'
discards 'const' qualifier from pointer target type [enabled by default]

Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1243841 - Quiet additional Make warnings and some code cleanup.

We make the following warnings go away:

osrf_legacy_json.c:607:6: warning: variable ‘fourth_dash’ set but
not used [-Wunused-but-set-variable]

osrf_legacy_json.c:836:5: warning: passing argument 3 of ‘makeNode’
discards ‘const’ qualifier from pointer target type [enabled by
default]

utils.c:133:2: warning: format not a string literal and no format
arguments [-Wformat-security]

We also cleanup the while block nested in a do while block around line
63 of osrf_cache.c to be more readable by adding braces and breaking
it across 3 lines.

Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1243841 - Quiet wrong format warnings during make install.

During make install, the compiler warns that %d expects an int when the
actual value is a long int.  Changing %d to %ld fixes the issue.

Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1243841 - Quiet unused return value warning in srfsh.c

Using the technique described here: https://stackoverflow.com/a/13999461.

Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1243841 - Quiet unused return value warnings.

Using advice given here: https://stackoverflow.com/a/13999461, "The
only good (if ugly) way to suppress these is to convert the return
value into something that the compiler agrees that you can ignore."

Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1243841 - Wrap truth test using "=" in an extra set of parens.

Referring to https://stackoverflow.com/questions/5476759/compiler-warning-suggest-parentheses-around-assignment-used-as-truth-value,
it is recommended to wrap variable assignments that are used as a truth
test within an extra set of parentheses.

Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP1340982: Ignore both 'comment' and '#comment' nodes in Settings Parse.

Modify the XML2perl helper function in OpenSRF::Utils::SettingsParser
to ignore comment nodes that have names of comment and #comment.

To reproduce the bug:

1. Stop OpenSRF services.

2. Add a XML comment, any text betwen <!-- and -->, in the list of
MARC templates in the opensrf.xml file.

3. Restart OpenSRF services.

4. In the staff client, go to Cataloging->Create New MARC Record.

5. In the list of templates, you will #comment where you added the
comment. (NOTE: I only tested with 1 comment.  Things may get worse
with more than 1 comment.)

6. There will be an error like the following in the
open-ils.cat_stderr.log if you attempt to choose the #comment entry:

   Caught error from 'run' method: Exception: OpenSRF::EX::ERROR
   2018-02-18T11:24:30 OpenSRF::Application
   /usr/local/share/perl/5.22.1/OpenSRF/Application.pm:240 System
   ERROR: Unable to open MARC template file: HASH(0x2249928) :

To test the fix:

1. Leave the comments in the opensrf.xml file from before.

2. Apply this commit, do make and make install for OpenSRF.

3. Just to make sure, do make and make install for Evergreen.

4. Repeat steps 3 and 4 from above.

5. You should NOT see any templates named #comment.

Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1762815 Empty client TZ defaults to server TZ (Perl)

Fixes an issue in the Perl client time zone handling that resulted in
the server defaulting to UTC time instead of the server time zone when
no time zone value was received from the client.

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Jason Stephenson <jason@sigio.com>

LP#1744158 Websocket proc exits on ejabberd disconnect

Any errors relaying websocket messages to OpenSRF now result in the WS
client being disconnected, allowing the WS process to exit.  This
prevents the WS gateway from accepting requests it cannot process and
allows the client to connect to a new WS process.

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Jason Stephenson <jason@sigio.com>

LP#1746577 Websocket responder exits on jabber disconnect

Regularly check for Jabber socket disconnects in the websocket gateway
"responder" thread (that relays messages from opensrf to the WS client)
and force a client disconnect when a broken jabber socket is detected.

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
Signed-off-by: Jason Stephenson <jason@sigio.com>

and continue to bump up version numbers

Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

bump up version numbers in master to reflect 3.0 as next major release branch

Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1708048: Fix ld problems by renaming libraries.

We add the lib... prefix to all C library names as expected by most
linkers.  This necessitates changes to the opensrf.xml configuration
file.

Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1708048: Add support for Debian 9 Stretch

  - Add new make target "debian-stretch"
  - Add Stretch instructions to README

Signed-off-by: Ben Shum <ben@evergreener.net>
Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1717350: fix chunking messages sent from Perl services

The chunk size adjustments introduced by the patches for bug 1709710
could result in calculating non-integral chunk sizes for Perl services.
This in turn led to fractional offsets and lengths being passed to
Perl's substr() function; rounding in turn can lead to characters
in the response getting silently dropped, which in turn broke
parsing the reconstituted response.

To test
-------
The problem can be reproduced by invoking

  open-ils.storage open-ils.storage.actor.org_unit.descendants.atomic 1, 0

in Evergreen databases with org unit trees large enough that the
response gets chunked.

Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Signed-off-by: Jason Stephenson <jason@sigio.com>

LP#1709710 Count Perl chunk/bundle sizes in bytes

For the purposes of bundling/chunking, count the number of bytes in each
affected string instead of the number of characters.

See also https://perldoc.perl.org/bytes.html and 'perldoc -f length'

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1709710: write unit tests for osrfXmlEscapingLength()

Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1709710: Make chunk sizing smart about XML quoting

XML inside JSON as a quoted string that's itself inside XML causes quite the
pile up of nested excaping of certain characters in OpenSRF PARTIAL_RESPONSE
messages.  Here we check for the worst offenders (<, >, &, and ") and account
for the cost of escaping them in chunked response stanzas.

Signed-off-by: Mike Rylander <mrylander@gmail.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1690206 - remove check of httpd.conf from OpenSRF Makefile.install

The original src/extras/Makefile.install included a grep of the
file /etc/apache2/httpd.conf, which is no longer installed by default
on supported Debian and Ubuntu releases.  As this check results in
an error message, it makes sense to remove the check altogether.

Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1697029 Log and exit on write to dead child

Confirm that a child process is alive just before attempting to write to
its pipe.  If the child process is dead, log the error, then drop the
message and move on.  This allows the parent to continue servicing
future requests.

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1711194: avoid division by zero errors

Under some circumstances, osrf_control --diagnostic may not
be able to deduce the correct max_children setting for a service,
e.g., if it's run without --localhost on a system that doesn't
have a opensrf.xml config section specifying active apps for a
specific hostname. When that happens, just display the count
of running drones rather than displaying error messages about
undefined $dmax values and divisions by zero.

Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Signed-off-by: Bill Erickson <berickxx@gmail.com>

LP#1711194 osrf_config --diagnostic reports max-children

--diagnostic output shows the maximum number of allowed drones per
service along with the active drone count.  Additionally, a usage
percentage value is displayed.

E.g.

$ /openils/bin/osrf_control -l --diagnostic

* open-ils.acq   [1581] uptime=00:35 cputime=00:00:00 #drones=1/15 6%
* open-ils.actor [1629] uptime=00:35 cputime=00:00:00 #drones=2/15 13%

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1704090: ensure make install respects DESTDIR

This patch ensures that 'make install' uses DESTDIR consistently,
making life easier for packagers.

Signed-off-by: Graham Billiau <graham@geeksinthegong.net>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

Revert "LP#1635737 Add optional context to interval_to_seconds"

This reverts commit a481100ef9d5bd9eaad5a87ce29776cb07a8687c.

Revert "LP#1635737: Unit tests for DST and date math"

This reverts commit 316f58375c40087bfae32234c4dd3817260831e5.

LP#1635737: Unit tests for DST and date math

Signed-off-by: Mike Rylander <mrylander@gmail.com>

LP#1635737 Add optional context to interval_to_seconds

Any given interval (e.g. "1 month") can be a different amount of
seconds depending on the context (i.e. "1 month" after February 1 is
March 1, but "1 month" after March 1 is April 1, yet March is longer
than February).  This affects months all the time, but also can affect
days, hours, and even seconds once you consider DST and "leap" times.

By giving an optional context to interval_to_seconds, you can find the
true number of seconds in, for example, "1 month", when starting from
"February 1" (the context).

Signed-off-by: Dan Wells <dbw2@calvin.edu>
Signed-off-by: Mike Rylander <mrylander@gmail.com>

LP 1703958: Update Websockets Intructions for Debian Jessie

Modify the Websockets installation instructions so that users will
have a working installation on Debian Jessie.  We change the "Debian"
instructions to say "Debian Wheezy" and add "Debian Jessie" to the
list with "Ubuntu Trusty / Xenial" where necessary.

Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1704116: fix intermittant failure of parallel building

Running make to do a parallel build (e.g., 'make -j 4' or
the like) could fail because of an undeclared dependency; this
patch fixes the issue.

The issue can be reproduced by repeating "make clean; make -j 4"
until the build fails.

Signed-off-by: Graham Billiau <graham@geeksinthegong.net>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1672926: Disable/remove default nginx config in REAMDE steps

Since we will be adding our own custom nginx config, disable/remove the
default one that is installed so there's no confusion later on.

Signed-off-by: Ben Shum <ben@evergreener.net>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1670045 - Correct Nginx README instructions

Previously, following the optional Nginx server setup
instructions resulted in failure for nginx to install
because Apache is already using ports 80 and 443.  Switch
the steps so that we change Apache's listening ports before
APT installation.

Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
Signed-off-by: Ben Shum <ben@evergreener.net>

Remove Fedora as a well-tested target

The Fedora install target requires a number of updates and is now
far from a "well-tested target".

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

LP#1667091 Remove non-SSL websockets sample configs

All WebSockets communication occurs via SSL in the sample configuration
files.  Non-SSL communication is still an option if required with local
configuration.

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1666706: add --with-websockets-port configure option

This patch adds the ability to specify the WebSockets
port as a configure option, avoiding the need to manually
edit a couple JavaScript files if one chooses to proxy
WS traffic.

This patch also cleans up the set of JavaScript files that
are installed so that some test case files are not installed
by default.

Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1616501: teach mod_perl handlers how to detect client disconnects

This patch provides an API so that mod_perl handlers
that act as OpenSRF clients have a way to specify that
if the browser disconnects, to stop trying to receive
results from an XMPP request.

To invoke it, mod_perl handlers can add the following:

use OpenSRF;
...
sub hander {
...
    my $r = shift;
    OpenSRF->OSRF_APACHE_REQUEST_OBJ($r);
...

Signed-off-by: Mike Rylander <mrylander@gmail.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

LP#1652382: more improvements to cache key munging

- teach osrfCacheRemove to clean keys
- fix implict declaration compilation warning
- account for fact that iscntrl('\0') returns true

Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Signed-off-by: Jeff Davis <jdavis@sitka.bclibraries.ca>

LP#1652382: handle cases where supplied key is longer than 250 bytes

With this patch, if cache clients want to use a key longer
than the memcached text protocol limit of 250 bytes, the
key is normalized to 'shortened_' + md5_hex(normalized_key).

Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Signed-off-by: Jeff Davis <jdavis@sitka.bclibraries.ca>

LP#1652382: Make use of the clean key just created

Signed-off-by: Mike Rylander <mrylander@gmail.com>
Signed-off-by: Kathy Lussier <klussier@masslnc.org>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Signed-off-by: Jeff Davis <jdavis@sitka.bclibraries.ca>

LP#1652382: normalization of memcache keys in C code

Memcache does not allow spaces in keys, so here we will actively strip them
from any key we get from a caller.  Some callers are not very proactive about
sending clean keys, and this patch prevents issues that can poison C-based
OpenSRF service backends.

Signed-off-by: Mike Rylander <mrylander@gmail.com>
Signed-off-by: Kathy Lussier <klussier@masslnc.org>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Signed-off-by: Jeff Davis <jdavis@sitka.bclibraries.ca>

LP#1655449: Bundling/chunking limits for SubRquests

We need to teach subrequests to inherit parent request bundling/chunking
parameters so they don't cause overruns in dispatch mode.

Signed-off-by: Mike Rylander <mrylander@gmail.com>
Signed-off-by: Jason Stephenson <jason@sigio.com>

LP#1652122: fix infinite recursion in opensrf.system.method.all

Under certain circumstances, calling opensrf.system.method.all on a
Perl service can result in an infinite recursion when attempting to
serialize an OpenSRF::Application object to JSON.  In particular,
this was observed to happen when doing an introspection of
the opensrf.settings service.

This patch avoids the infinite recursion (and consequent memory
leak) by ensuring that the 'session' key is slated for exclusion
from serialization from OpenSRF::Application objects during
bootstrapping.

Note that the problem does not affect all Perl services; if a
Perl service declares at least one streaming method, the auto-registration
of the .atomic method will result in 'session'-stripping.

This patch fixes a regression introduced in bug 1350457.

To test
-------
[1] Run 'introspect opensrf.settings' via srfsh; observe
    that it never returns and that the opensrf.settings drone
    will grow in memory sized until killed.
[2] Apply the patch, then repeat step 1. This time, the
    request should succeed.

Signed-off-by: Galen Charlton <gmc@esilibrary.com>
Signed-off-by: Mike Rylander <mrylander@gmail.com>

LP#1648188: example HAProxy configuration

Add an example configuration for using HAProxy.

Signed-off-by: Galen Charlton <gmc@esilibrary.com>

LP#1638651: add instructions for using NGINX

Signed-off-by: Galen Charlton <gmc@esilibrary.com>

LP#1638651: example Nginx websockets/http(s) proxy config

Example using Nginx to proxy all websocket, http, and https Apache
traffic.

Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Galen Charlton <gmc@esilibrary.com>

LP#1382038: clarify one step of installing websockets support

Specify directory to be in before copying the Apache websockets
configuration file.

Signed-off-by: Galen Charlton <gmc@esilibrary.com>