LP#1224647: remove two invalid tests

The patch for bug 1204123 changes the client_recv()
to not set the transport_client error flag, as most
of the circumstances where it would have been set were
for cases where the call to select() was interrupted
by a signal, which is not an error per se.

This patch removes two tests that were therefore
made invalid, restoring the ability of the test suite
to pass.

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

osrf_control --start/stop/restart-services

Provide commands for controling non-router services.  This is useful in
a multi-server environment where the router runs on a different server.

Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Thomas Berezansky <tsbere@mvlc.org>

LP#1204123 repair makefile.am warning

Avoid trailing space after backslash

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

LP#1204123 osrf_control warn and exit on bad host

Any time a start action is issued (start, start_all, restart,
restart_all), osrf_control will first verify that the selected hostname
(or localhost) hosts the requested service(s).  If not, the user is
warned and the script exits before any action is taken.

Note: we do not make a similar verification for stop and signal actions,
since those may be reasonably be used even when a service is not
configured to run on the selected host.

Thanks to Jason Stephenson for the suggestion.

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

LP#1204123 osrf_control --diagnostic improvements

Assessing the state of each PID for each service for error conditions.

Minor cleanup.

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

LP#1204123 osrf_control --diagnostic

Command prints information about running services, including
descrepencies between running vs configured and PS listing vs PID files.

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

LP1204123 osrf_ctl.sh improvement

Removing no-longer-supported --verbose flag from osrf_ctl.sh stub

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

LP1204123 osrf_control doc updates

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

C SIGHUP handling and config reloading

Sending the HUP signal to a C Listener process now results in the
following:

 * Reload the opensrf_core config
 * update the log file level
 * kill idle child processes
 * child processes that are active when the signal is received are
   tracked and killed once they become idle.
 * New children are spawned per the min child settings

The primary use case for these changes is temporarily changing the log
level for a given service for debug purposes.  It may also
be used, for example, to gracefully recover excess RAM consumed by a
child process.

opensrf.xml (opensrf.settings config) is not reloaded, so min/max child
settings will not be affected.

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

LP1204123 more osrf_ctl/control script cleanup

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

LP1204123 more osrf_ctl/control script cleanup

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

LP1204123 osrf_control improved sample usage

Use a more realistic default usage message.  --config and --pid-dir have
sane defaults, so people will not normally need to specify those.

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

LP1204123 install opensrf-perl.pl as osrf_control

Symlink osrf_control to opensrf-perl.pl to act as the replacement for
osrf_ctl.sh.  I chose "osrf_control" since it matches more closely to
"osrf_config" -- also it's probably less confusing than calling it
osrf_ctl, which would likely get confused w/ osrf_ctl.sh

TODO: documentation

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

LP1204123 opensrf-perl.pl improve logging

Log messages by default.  Replace --verbose flag with --quiet flag.

Also treat all messages the same, instead of separating them into info
and debug.  They're all pretty useful.

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

LP1204123 opensrf-perl.pl expansion continued

* improved cleanup of stale pid files during startup
* added --force-clean-process option to kill orphan (no pidfile)
  processes during startup
* other minor cleanup

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

LP1204123 opensrf-perl.pl expansion / replace osrf_ctl

opensrf-perl.pl can now stop/start/signal/etc. all opensrf services,
regardless of language.  It is in effect a replacement for osrf_ctl.sh
with considerably broader powers.

To ease transition, osrf_ctl.sh has been taught to pass
start/stop/restart_all commands through to opensrf-perl.pl.

The layout of commands has changed some (e.g. --start-all instead of
--action start_all) and a host of new commands have been added.

Below are the full set of commands.  See --help for full descriptions:

--config
--pid-dir
--settings-startup-pause
--localhost
--service
--verbose
--no-daemon
--help
--start-all
--start
--restart-all
--restart
--stop-all
--stop
--graceful-shutdown-all
--graceful-shutdown
--fast-shutdown-all
--fast-shutdown
--immediate-shutdown-all
--immediate-shutdown
--kill-with-fire
--signal-all
--signal
--signal-timeout

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

LP1204123 Remove osrf_ctl debug echos

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

LP1204123 Improved per-service control (C/Perl)

C opensrf no longer mantains a single master process.  Instead, like
Perl, each Listener process writes its own PID file and can be managed
individually.  Related to this, much code was cleaned up in
osrf_system.c.

osrf_ctl.sh now has the ability to stop/start individual services for
Perl and C, using the new -s <service> option.  Examples:

osrf_ctl.sh -l -a restart_c -s opensrf.math
osrf_ctl.sh -l -a restart_perl -s opensrf.settings

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

LP1204123 osrf_ctl.sh supports sending signals

Using the following new options to osrf_ctl.sh, the script can now send
signals to any/all OpenSRF Listener processes:

-a signal / signal_all
-k <signal> [value passed to 'kill -s']
-s <service>

With an action of 'signal' and service provided by -s, the specified
signal is sent only to the listener process of the service.

With an action of 'signal_all', the specified signal is sent to all
listener prcesses.

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

LP1204123 Don't treat interrupts as errors

Interrupted calls to select() are generally not errors, but more likely
signals received by the process.  Avoid setting the transport_client
error flag to true in these cases.  Otherwise, after one signal is
received, no other outbound communication can occur on the client
connection.

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

LP1204123 SIGUSR2 causes router re-register (Perl/C)

When a listener process receives the USR2 signal, the 'register' command
is sent to all known routers.  This allows for the addition of new
routers to running opensrf services.

If a register command is sent to a router for which the process is
already successfully register, the router will safely discard it, so
multiple SIGUSR2 calls are safe.

Minor int => bool clarification repair to existing C shutdown
(prefork_clear) code.

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

LP1204123 opensrf.settings reload file option

opensrf.settings API calls

opensrf.settings.host_config.get
opensrf.settings.default_config.get

now sport an additional "reload" boolean parameter.  When set, the settings
file (opensrf.xml) will be reloaded from the file system to pick up any
changes which have occurred since the last load/reload.

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

LP1204123 SIGTERM graceful shutdown (C)

When a TERM signal is received, the listener parent process will wait
for all child processes to complete any active tasks before killing the
child processes and shutting down.

Receiving a SIGINT or SIGQUIT results in a non-graceful shutdown.

In all cases, the system first un-registers with all routers.

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

LP1204123 SIGUSR1 causes router unregister (Perl/C)

$ kill -s USR1 <listener_pid>

The listener process will unregister all router connections.  This
allows services to remove themselves from consideration for new
inbound requests while allowing their drone processes to complete
any currently running tasks.

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

LP1204123 SIGTERM causes graceful shutdown (Perl)

When sent the SIGTERM signal, listener processes will wait for all child
processes to complete their currently running tasks before killing all
child processes and exiting.

SIGQUIT and SIGINT can still be used for semi-graceful shutdowns, where
the listener de-registers and cleans up child processes, but does not
wait for child processes to finish their tasks.

To kill with fire, SIGKILL is still your friend.

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

LP1204123 Set SIGCHLD handler to DEFAULT for children (perl)

Remove the special SIGCHLD handler applied to the parent/listener
process from spawned child processes (drones) by setting child handler to
DEFAULT.  Otherwise, if an OpenSRF drone process spawns a sub-process,
the drone will execute the SIGCHLD handler meant for the Listener when
the sub-process dies, wherein hijinks ensue.

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

silence some uninitialized warnings

Signed-off-by: Jason Etheridge <jason@esilibrary.com>
Signed-off-by: Bill Erickson <berick@esilibrary.com>

LP#1188195: add tests for setting default client locale

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

LP#1188195: Default per-process client locale (Perl)

Get/set the locale used by all new client sessions
for the current process.  This is primarily useful
for clients that wish to make a series of opensrf
calls and don't wish to set the locale for each new
AppSession object.

The caller should reset the locale when done using
reset_locale(), as the locale will otherwise persist
for the current process until set/reset again.

This is not for SERVER processes, since they
adopt the locale of their respective callers.

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

LP#1208860: fix sprintf without format string.

Fixes error preventing installation on Debian testing and
removes warning on earlier versions of Debian.

Signed-off-by: Pasi Kallinen <pasi.kallinen@pttk.fi>
Signed-off-by: Galen Charlton <gmc@esilibrary.com>

LP1198983 disable multipart/mixed for Firefox

Only allow multipart mixed/replace message within the Evergreen staff
client for now.  Eventually, multi-part messages will be wholly
deprecated.

Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Dan Scott <dscott@laurentian.ca>

LP#1162907: don't require installing RPC::XML

RPC::XML is not required by OpenSRF, although it is an
Evergreen dependency.

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

Multisession blocking repair

The new socket blocking code for multisession failed to take into
account that socket activity outside of the main block could lead to a
deadlock situation.  For example:

* Check status of request A -> not complete
* Check status of request B -> whatever
* Request A may now be complete, since checking the status of any request
  affects all requests
* Return to blocking loop because we think there is pending data, but in
  fact all data has already been pulled from the socket.

The solution is for session_reap() to make a sweep and check for changes
in requests that are now complete as a side-effect of checking for
completed requests.

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

When running methods for clients, send plain warnings to "real" logs

Code inside an OpenSRF application method may use Perl libraries that warn
and carp like most Perl code is wont to do.  Instead of letting
those message go to STDERR where they can be easily missed (and take up
lots of disk space on application boxes), why not catch them and
redirect them to our "real" logs using OpenSRF::Utils::Logger ?

Deployment of this change would probably have the side effect of bringing
to light bugs in applications (Evergreen) that will suddenly seem very
noisy.

Signed-off-by: Lebbeous Fogle-Weekley <lebbeous@esilibrary.com>
Signed-off-by: Galen Charlton <gmc@esilibrary.com>

Minor whitespace repairs in Server.pm

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

Perl SIGHUP handling and config reloading

Sending the HUP signal to a Perl Listener process now results in the
following:

 * Reload the opensrf_core config
 * re-init the logger
 * kill idle child processes
 * child processes that are active when the signal is received are
   tracked and killed once they become idle.
 * New children are spawned per the min child settings

The primary use case for these changes is temporarily changing the log
level (or log file) for a given service for debug purposes.  It may also
be used, for example, to gracefully recover excess RAM consumed by a
child process.

Not all values in opensrf_core.xml are affected by a SIGHUP.  Since the
goal is a gracful reload, no attempt is made by the listener process to
re-connect to jabber or re-register with the opensrf router(s).  Child
processes will by necessity connect to Jabber during startup, though, so
any changes to the jabber configuration will affect child processes.  In
general, it's best to affect jabber configuration changes with a true
service restart.

opensrf.xml (opensrf.settings config) is not reloaded, so min/max child
settings will not be affected.

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

LP#1101254: remove memory leak in HTTP translator

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

Debian wheezy Makefile.install target

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

Block on recv instead of loop/polling in MultiSession

When the time comes to wait for responses to arrive, block on the XMPP
socket (which uses select() under the covers) until data arrives,
instead of looping furiously and calling receive in non-blocking mode.
Before this change, waiting on responses resulted in long-running CPU
spikes.

Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Lebbeous Fogle-Weekley <lebbeous@esilibrary.com>

Stop using a non-standard default PREFIX for installs

Working towards packaging, we will be better off if we start getting used to
installing OpenSRF in standard FHS directories.

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

LP#1132247: fix compilation warnings in C test cases

Also, since osrfList maintains a list of pointers, not
values, adjust some of the test cases to discourage
anybody inclined to copy-and-paste from the test cases
from storing pointers to stack variables in an osrfList.

Signed-off-by: Galen Charlton <gmc@esilibrary.com>
Signed-off-by: Ben Shum <bshum@biblio.org>

Logger.pm whitespace cleanup

Apply 4-space "tabs" consistently.

Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Lebbeous Fogle-Weekley <lebbeous@esilibrary.com>

Enable client logtrace with environment vars

Supports a new environment variable OSRF_LOG_CLIENT which, if true,
enables control and generation of the client log trace value.  This is
the same as setting <client>true</client> within the opensrf core
configuration file.

As a shortcut, if the MOD_PERL environment variable is set, assume
client=true.

This allows clients and non-clients to share an opensrf core
configuration file, when previously the only difference between the two
was the <client> setting.

Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Lebbeous Fogle-Weekley <lebbeous@esilibrary.com>

Test for Apache executable in sbin dirs

Debian apparently doesn't include /usr/sbin in the default user PATH, so
add an APXS2-like lookup with likely locations if we don't find the
apache executable in our standard path.

Signed-off-by: Dan Scott <dscott@laurentian.ca>
Signed-off-by: Jason Etheridge <jason@esilibrary.com>
Signed-off-by: Ben Shum <bshum@biblio.org>

Support Apache 2.4 client IP address lookups

The Apache 2.4 API replaces the conn_rec->remote_ip member with
conn_rec->client_ip or conn_rec->useragent_ip (per
http://httpd.apache.org/docs/2.4/developer/new_api_2_4.html). client_ip
seems to be the best choice for us, to avoid everything being logged
from the load balancer or proxy instead of the client's address.

This code detects the version of Apache and uses client_ip if it is 2.4
or greater.

Signed-off-by: Dan Scott <dscott@laurentian.ca>
Signed-off-by: Bill Erickson <berick@esilibrary.com>

Prevent "uninitialized value" warnings in parameter logging

Use of uninitialized value $p[0] in join or string at
/usr/local/share/perl/5.10.1/OpenSRF/Application.pm line 130.

This is caused when the array of method params contains null/undef
values.  Prevent the warnings by replacing these values w/ empty
strings.

Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Dan Scott <dscott@laurentian.ca>
Signed-off-by: Galen Charlton <gmc@esilibrary.com>

Change OSRF_JAVA_DEPSDIR so building Java just works.

OSRF_JAVA_DEPSDIR was being set to /opt/java by configure without any
documentation to that effect. The src/java/deps.sh downloads the deps files
to src/java/deps. This means that you cannot just build java without either
copying the jars from src/java/deps or altering src/java/Makefile.

This edit changes the AC_SUBST call to replace OSRF_JAVA_DEPSDIR with deps,
so that you can at least build java without making any changes.

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

Safer casting in java config parsing

Java config parsing, in particular getString and getInt, no longer fail
when encountering a number value in the internl JSON->Map object.

Java does not allow the following cast:

String s = (String) someNumber;

Instead, rely on the object's toString() which is safe and guaranteed
to exist.

Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Jason Stephenson <jstephenson@mvlc.org>
Signed-off-by: Dan Scott <dscott@laurentian.ca>

Typo in configure.ac: 'framweork'

Reported by David Busby of edoceo in
https://bugs.launchpad.net/opensrf/+bug/1080458 - thanks David!

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

Add 2.1.2 ChangeLog entries

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

Bump version numbers for 2.1.2

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

Whitespace in OpenSRF/System.pm

Spaces not tabs.

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

Move setting of OpenSRF::Application::shared_conf to load_bootstrap_config.

shared_conf was not available and broke clients that were not in a
service, such as the Evergreen CStoreEditor.

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

Bump release numbers, create 2.1.1 change log

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

ChopChop is dead, long live ChopChop.

It was never fully baked, nor was it secure, nor does it compile cleanly
with -Wall, nor does it provide any useful examples for working with
opensrf, etc.  Time to clear out.  So long, chopchop.

Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Dan Scott <dscott@laurentian.ca>

Bump libopensrf version-info revision and age

The log redaction functionality changed the source files (thus 'age'
gets bumped) and is backwards-compatible (thus 'revision' gets bumped)
but maintains the same interface (thus 'current' stays the same).

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

Purge the wildly out-of-date Roadmap document

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

Protect against empty/invalid log_protect sections

Connectivity would fail if the log_protect section of opensrf_core.xml
was empty, or contained only comments, as it does in the default
example. Add a simple guard against this potential problem.  This fix
will also protect against cases where the 'log_protect' section
contains text rather than separate configuration elements.

Credit to Dan Scott for finding the bug and working out how to fix it.

Signed-off-by: Dan Wells <dbw2@calvin.edu>
Signed-off-by: Dan Scott <dan@coffeecode.net>

Consolidate duplicate osrfMethodVerifyContext handler

Log redaction was not occuring in some cases because the code was using
the OSRF_METHOD_VERIFY_CONTEXT macro instead of the similarly named
function which does the same thing.  This change points the macro at the
function so that all code uses the same underlying code.

Note this change turns on CALL param logging unconditionally, whereas
users of the macro would previously have been able to avoid CALL logging
via the OSRF_LOG_PARAMS variable.  In practice, little code uses the
macro and all code enables OSRF_LOG_PARAMS.  If we need to add this
control back, it can be added directly to osrfMethodVerifyContext().
For now, it's one less env variable we need to define.

Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Dan Scott <dan@coffeecode.net>

Log redaction for sensitive input values, Perl side

This commit attempts to do the same as the C log redaction fix,
but now at the Perl level.  The Perl configuration code was a
little more crufty than the C side, so an additional feature was
added to Config.pm to support the new 'shared' section.  At some
point we should consider a ground-up rewrite of Config.pm, as the
code seems to suffer some from its INI file roots.

Signed-off-by: Dan Wells <dbw2@calvin.edu>
Signed-off-by: Dan Scott <dan@coffeecode.net>

Log redaction for sensitive input values, C side

Some service/methods deal with sensitive information (passwords,
financial, etc.).  All input values (e.g. gateway method params)
are currently logged in the activity log regardless of your log
level.  This commit will allow you to redact the params of any
method which matches a configurable set of left-anchored string
values.

This commit adds the initial config, and covers redaction of method
parameters sent through the gateway, the translator, and more general
OpenSRF C applications.

Signed-off-by: Dan Wells <dbw2@calvin.edu>
Signed-off-by: Dan Scott <dan@coffeecode.net>

Fix installation on Ubuntu Precise.

Remove libreadline5-dev and replace with libreadline-dev for Ubuntu
and Debian.  This installs libreadline6, but everything still works
since there's nothing version specific in our use of libreadline.

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

Use apt-get instead of aptitude on Debian / Ubuntu

Reports from the field state that aptitude is not installed by default on
Ubuntu any longer; thus go with the sure thing.

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

Remove the reference to Evergreen in the README

Stephen Wills reported problems installing Evergreen because of missing
dependencies, and reading the OpenSRF README shows that it refers to the
Evergreen prerequisite installer in a confusing way that might lead to
users using only the Evergreen Makefile.install, rather than using the
OpenSRF Makefile.install.

In addition, Fedora 16 is going to be out of support soon, and Fedora 17
and 18 are well-tested targets now.

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

No, Ubuntu Hardy is not well-tested for 2.1.0

One more reference to Ubuntu Hardy that we can remove from the
README/INSTALL.

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

Bump version numbers to help with library compatibility

By bumping the OpenSRF version numbers for Perl libs, Python libraries,
and the libtool versioning for the libopensrf library, projects that
build on OpenSRF will be able to flag the minimum required version and
bail out early if an older version of OpenSRF has been installed.

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

Add "tar" to base prereqs to appease autotools

On a minimal install of Fedora 17, I was running into the perplexing
error message whilst running 'autoreconf -i':

libtoolize: can not copy `/usr/share/libtool/config/ltmain.sh' to `./'

This was confusing because a manual copy would, in fact, copy the file
just fine.

http://lists.gnu.org/archive/html/libtool/2009-07/msg00030.html finally
lead to enlightenment: autotools uses "tar" to copy files, not "cp".
Thus, to avoid similar head-scratching install problems in the future,
add "tar" to the base prerequisites for building OpenSRF (both to the
DEBs list and the RPMs list).

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

Update OS support in README / Makefile.install

Kick Debian Lenny, Ubuntu Hardy, and RHEL 5 / CentOS 5 to the curb.

Also change the name of the README to the more generic & instructive
"Installing OpenSRF" rather than "README for OpenSRF #.#.#".

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

Nagios Example Plugin for monitoring services

Does not check that all drones in a brick are fully up, just that the
entire brick will respond to each service, even if only one drone happens
to be running the listener properly (and said listener is responding).

Signed-off-by: Thomas Berezansky <tsbere@mvlc.org>
Signed-off-by: Dan Scott <dan@coffeecode.net>

Detect and repair multipart/mixed message delivery errors

For unknown reasons, the Content-Type header will occasionally be
included in the XHR.responseText for multipart/mixed messages.  When
this happens, strip the header and newlines from the message body and
re-parse.

Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Dan Scott <dan@coffeecode.net>

Remove Evergreen 2.0 from automated builds

rel_2_0 is no longer in support, thus it's time to remove it from the
automated testing builds.

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

fix up index/position type for calls of various osrfList* functions

osrfListSet, osrfListRemove, osrfListGetIndex, and osrfListExtract
all expect unsigned ints for the index/position parameter.

src/jserver is ignored by this commit as its removal is pending.

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

Remove comparisons that can never evaluate to true

Using clang as the compiler results in 4 warnings like the following:

osrf_list.c:106:23: warning: comparison of unsigned expression < 0 is
always false [-Wtautological-compare]
        if(!list || position < 0) return NULL;
                    ~~~~~~~~ ^ ~

(Explanation: "position" is an unsigned int; thus the comparison to < 0
can never evaluate to true).

Signed-off-by: Dan Scott <dan@coffeecode.net>
Signed-off-by: Galen Charlton <gmc@esilibrary.com>

LP954059: Silence uninitialized var warning

Compiling osrf_utf8.c generates the following warning:

osrf_utf8.c:510:29: warning: utf8_char may be used uninitialized in this
function [-Wuninitialized]

So... initialize utf8_char when we declare it, and make the compiler
happy.

Signed-off-by: Dan Scott <dan@coffeecode.net>
Signed-off-by: Galen Charlton <gmc@esilibrary.com>

LP# 953299 - defend against null and zero-length cache keys

Ignore undefined and zero-length (after key normalization) cache
keys.

Signed-off-by: Galen Charlton <gmc@esilibrary.com>
Signed-off-by: Dan Scott <dan@coffeecode.net>

LP# 953299 - Prevent get/set of invalid cache keys

Clients of OpenSRF::Utils::Cache occasionally request cache keys that
contain invalid characters (a particular case is ISBNs that contain
spaces), so strip those out of incoming get/set requests to avoid ugly
memcached errors.

Signed-off-by: Dan Scott <dan@coffeecode.net>
Signed-off-by: Galen Charlton <gmc@esilibrary.com>

.gitignore - ignore more built stuff in fewer lines

Use the power of glob to catch more built files that we want to ignore,
while simplifying the .gitignore file significantly.

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

Revert inadvertently introduced debugging code

In commit 91b8790c, several debugging lines were accidentally committed
to the OpenSRF caching utility. Revert that change.

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

Minor cleanups to Java dependency build process

While configure.ac still hardcodes the expected location of the Java
dependencies (JSON and Memcached classes), we can clean up some of the
lower-level challenges with the Java build.

* StAX and WSTX were rolled into the core Java environment long ago,
  so there's no need to download them and even less need to verify
  that the downloaded version exist.
* The Memcached class is now up to 2.0.1, per deps.sh, but the deps.inc
  file was pointing at 1.5.1.
* Speaking of the deps.inc file, nothing seems to use it; delete it.
* The Makefile was dying because the variables for the Memcached and
  JSON classes weren't defined. Define those at the top of the Makefile.

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

Clean up root directory: INSTALL, .gitignore, autoreconf

* Update the README to avoid running autoreconf with the "-f" flag.
* Make the INSTALL file a symbolic link to the README to avoid
  creating a generic INSTALL file each time autoreconf is run.
* Add a .gitignore file that ignores all of the built files.

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

Change Java deps.sh to include . in CLASSPATH

Following the directions given by running deps.sh was a little bit
frustrating; we need to work in some documentation on how to use the
Java bits of OpenSRF - and perhaps look at a more standard option like
maven for dependencies.

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

Java Gateway interface improved exception handling

Handle any exceptions that should not reasonably occur in normal
operation under the covers.  Bubble the rest up.  Update test code with
examples.

Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Dan Scott <dscott@laurentian.ca>

Java gateway interface test class

Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Dan Scott <dscott@laurentian.ca>

Java HTTP gateway interface

Supports sync and async requests.  Async requests support onResponse,
onComplete, and onError handlers.

Supports a max-threads value to limit the number of activately
communicating threads over any connection.  When max-threads is reached,
requests are queued and delivered as soon as there is room.

Note that since this is talking to the OpenSRF gateway and not the
translater, responses are simply collected and passed one at a time to
onResponse.  They are not streamed.  The goal of supporting onResponse
is to provide the same client API for both the gateway and translator.

Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Dan Scott <dscott@laurentian.ca>

Remove GNU default INSTALL file

GNU autotools generate an INSTALL file that is generic and which
conflicts with the instructions given in the README. Installation is
already hard enough without conflicting instructions, so delete the
INSTALL file.

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

autotools - do not explicitly include m4 directory

Some versions of autotools complain bitterly if an m4 include directory
is specified that does not exist.

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

Name the bootstrapping steps in buildbot

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

Fix buildbot configuration

Need to define our tests before they're called; also, can't blindly
invoke a step out of the proper scope. Duh.

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

Switch to autoreconf instead of autogen.sh

Update the buildbot config accordingly to avoid erroneous errors of
erroneosity.

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

Updated buildbot.cfg for current build environments

* Drop Ubuntu 8.04 from the list of build environments.
* OpenSRF: drop rel_1_6, add rel_2_1
* Evergreen: drop rel_1_6_1, add rel_2_2
* Adjust for buildbot 0.86 API changes to avoid deprecation
* Improve PEP8 compliance

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

Add trailing period, "localhost" to ejabberd.cfg example

Thanks to Yamil Suarez for noticing a discrepancy between the older wiki
instructions and the README.

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

Prevent undef warnings on perl socket read nbytes test

Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Dan Scott <dan@coffeecode.net>

Detect remote disconnect in Perl XMPP reader

When the jabber server severs the connection, it leaves the Perl libs
with a socket that perpetually appears ready for reading, but always
returns 0 bytes.  This produces a loop in the client code.  This change
detects this situation, logs an error, and throws an exception.

Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Dan Scott <dscott@laurentian.ca>

Protect gateway from format-string crashes in data

As a common security measure, printf-style formatting codes are
not allowed to be directly interpreted from a writable segment.
The gateway code currently has the following function call:

osrfLogActivity( OSRF_LOG_MARK, act->buf );

This is a variadic function which expects the 'act->buf' position
to contain a format string and any trailing arguments to be the
values passed to the formatter.  Since act->buf is the value of
what we passed in, some data inadvertantly contains format strings,
and since it is a writable segment, the program crashes.  Here is
an example of a crash-causing call:

http://localhost/osrf-gateway-v1?service=test&method=test&param=%22%251n%22

The param is interpreted as "%1n" and abruptly fails.

The simple solution is to include a formatter so that our param gets
demoted to being mere data, i.e.:

osrfLogActivity( OSRF_LOG_MARK, "%s", act->buf );

Signed-off-by: Dan Wells <dbw2@calvin.edu>
Signed-off-by: Dan Scott <dscott@laurentian.ca>

Stop warning about missing parentheses...

...by adding them.

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

Refresh child file handles on status read

If a child process dies while the parent is attempting to read status
information from the child, the pipe connecting the two will be cleaned
up.  The parent mustn't attempt to read from the dead pipe or it will
result in a bad file descriptor error, culminating in a high-cpu
infinite loop on the parent (Listener) process.

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

Python libs for OpenSRF ingress tracking

osrf.ses.Session.ingress(ingress)

This also set the "srfsh" ingress value for srfsh.py.

Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Mike Rylander <mrylander@gmail.com>

Set OpenSRF ingress value for srfsh/gateways

Sets the "srfsh", "gateway-v1", and "translator-v1" ingress values
accordingly.

For the translater, it's necessary to stamp the unpacked messages with
the updated ingress, then re-serialize before sending the messages along.

Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Mike Rylander <mrylander@gmail.com>

C libs for OpenSRF ingress tracking

osrfAppSessionSetIngress(<ingress>);

Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Mike Rylander <mrylander@gmail.com>

Perl libs for OpenSRF ingress tracking

Ingress is a free-form text value which represents the entry point for
the client into the opensrf network.  The value is passed within opensrf
messages, similar to "locale".  Clients should specify the ingress
before any opensrf communication occurs.

OpenSRF::AppSession->ingress($ingress);

Stock values include the following:

opensrf (default)
srfsh
translator-v1
gateway-v1

Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Mike Rylander <mrylander@gmail.com>