Release 5.2.

Much overdue!

Put myself as the primary maintainer.

tests/dtest.py: Force a sensble locale if we don't have one.

Otherwise the server gets sad when it tries to convert track names
containing non-ASCII characters.  I picked `C.UTF-8' as being available
even when not explicitly configured.

server/Makefile.am: Add the codec test for Ogg Vorbis.

Now that we have our fuzzy comparison, this is safe to permit.

server/Makefile.am: Allow discrepancies for lossy codecs.

It seems that `libMAD' on ARM32 doesn't produce the same output as it
does on x86; and the ARM64 version is a looooong way off.  I've not
investigated, but I suspect details of floating point and/or SIMD
optimization.  Anyway, smallish $L_\infty$ distance isn't especially
concerning.  After all, we're trying to make sure that we're using the
decoders right, rather than that the decoders conform to the relevant
specifications.

scripts/compare-raw, server/Makefile.am: Add script for comparing raw audio.

It does a very stupid comparison of corresponding samples to ensure that
they're not too far apart.  This is still an improvement over using
cmp(1).

clients/playrtp.c: Configure the backend audio device before use.

This means it stands a chance of working if your audio device has a
weird mixer channel-name.

debian/.gitignore: Move existing patterns from top-level `.gitignore'.

debian/: Add .gitignore

Ignores these files, which are generated by dpkg-buildpackage -uc -b

 debian/.debhelper/
 debian/build/
 debian/disobedience.debhelper.log
 debian/disobedience.postinst.debhelper
 debian/disobedience.postrm.debhelper
 debian/disobedience.substvars
 debian/disorder-gstreamer.debhelper.log
 debian/disorder-gstreamer.substvars
 debian/disorder-playrtp.debhelper.log
 debian/disorder-playrtp.substvars
 debian/disorder-server.debhelper.log
 debian/disorder-server.postinst.debhelper
 debian/disorder-server.postrm.debhelper
 debian/disorder-server.preinst.debhelper
 debian/disorder-server.prerm.debhelper
 debian/disorder-server.substvars
 debian/disorder.debhelper.log
 debian/disorder.substvars
 debian/tmp/

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

examples/disorder.init.in: Read settings from `/etc/default/disorder'.

Most usefully, one can tweak locale settings here.

server/dump.c: Try to set the locale on startup.

Otherwise we get annoying cronspam if the configuration contains funny
characters.

cgi/cgimain.c: Make the CGI program be (a little) locale-aware.

Otherwise it can't properly parse configuration files which contain
non-ASCII characters, e.g., for transforming pieces of track names.

clients/disorder.c: Force line buffering when writing log.

Otherwise it looks fine on a terminal, but that's not very useful.  If a
program tries to read the log over a pipe, then it sees nothing for a
good long while until the buffer gets flushed.

This change is specific to the `log' command.  Output for other commands
comes out at the same time anyway.

disobedience/control.c: Follow user toolbar style in full-size window.

Compact mode forces the icons-only style still, because smaller.

lib/uaudio-pulseaudio.c: Add volume control support.

Now that we have everything in place, implement PulseAudio volume
control.

lib/uaudio-pulseaudio.c: Rewrite using the asynchronous API.

It's really hard to do volume control using the `simple' synchronous
API, because that involves `introspection' requests to the server, which
aren't part of the API, and it involves knowing the stream index, which
the API won't give us.

The rewrite isn't especially painful.

disobedience, playrtp: Have `playrtp' handle volume control.

If the server is playing the audio directly, then it handles the volume
control too, as before.

If the server's transmitting using RTP, DisObedience /used/ to try to
twiddle the volume itself.  Instead, arrange for it to request volume
adjustment of the running `disorder-playrtp' instance via its socket
interface.

This has two advantages.

  * Firstly, `disorder-playrtp' actually knows which audio API it's
    using and therefore which method for fiddling with the volume will
    work best.  Indeed, DisObedience doesn't even have any configuration
    for selecting audio APIs, so it's only ever right by coincidence.
    On the other hand, `disorder-playrtp' has all of the necessary
    machinery.

  * Secondly, PulseAudio in particular has independent volume controls
    per input.  DisObedience has no hope of guessing which of these is
    the right one for `disorder-playrtp' without help, and it's cleaner
    just to give the whole job to `disorder-playrtp'.

lib/: Use Salsa20/8 for random bits, rather than RC4.

It's faster and produces better quality random bits; RC4's biases are
somewhat notorious.

configure.ac: Add `chromium' and `google-chrome' to browser possibilities.

Prefer Chromium over the fully Googly version because free software and
less spyware.

configure.ac, debian/rules: Use `sensible-browser' by default.

Use this rather than `x-www-browser' because the former can be
influenced by individual users by setting `BROWSER', while the latter
uses a symlink set by the system administrator and ignores individual
user preferences.

CHANGES.html: Fix miscapitalization of `Disobedience'.

Where did I get the idea that it was supposed to be like this?

CHANGES.html: Mention GStreamer-based tracklength plugin.

plugins/tracklength-gstreamer.c: Remove unused header inclusion.

plugins/tracklength-gstreamer.c: Use `GST_SECOND' instead of `1000...'.

Honestly I'm rather surprised that I typed the right number of zeroes.

debian/control: Demote `disorder-server' requirement on `httpd-cgi'.

Now `Recommends', since it works OK without a webserver, though it does
limit your options for controlling it to the provided dedicated
clients (and many others which someone else develops).

plugins/Makefile.am: Build standalone tracklength program.

This is mostly how I've been testing it; it seems harmless to include it
here.

plugins/tracklength-gstreamer.c: Rewrite to use `GstDiscoverer'.

The old version worked, but was fiddly, and very slow at some MP3
files.  It seems that if you start playing for a few milliseconds and
then ask, then you get a good answer, but since I found this out by
tripping over the `GstDiscoverer' machinery that GStreamer already has,
it seemed like a better idea to just use that.  Which means almost all
of the code has gone.

debian/: Rename `disorder-server' templates so Debhelper can find them.

Oops.  I bungled 026a384f68227a00b2d33ca196d7c498ba643d4a.

plugins/tracklength-gstreamer.c: Add GStreamer-based tracklength plugin.

Now we can have the proper lengths for all supported files.

configure.ac, debian/: Set up correct dependencies for GStreamer.

This involves an unpleasant back-channel from the configure script to
the Debian packaging machinery to explain which GStreamer version it
chose, so that we can set the proper package names.

debian/control: Rename `disorder-gstdecode' to `disorder-gstreamer'.

This package will include other GStreamer-based goodies.

debian/control: Remove server dependency on `sox'.

It's not needed because the Debian build always uses `libsamplerate'.

debian/control: Order `Build-Depends' alternatives by preference.

I think this is mostly for the benefit of maintainers using it as a
cribsheet of packages to install.

server/gstdecode.c: Remove pointless casts to `GstElement'.

The `pipeline' already is one.

server/gstdecode.c: Label dest element correctly on link failure.

server/gstdecode.c: Report more useful messages for missing plugins.

server/gstdecode.c: Dissect the message more portably.

We can use `gst_message_get_structure' in both versions, so do that
rather than ifdeffery.  Use the `GST_MESSAGE_TYPE' macro to get the
type, for future compatibility.

server/gstdecode.c: Unref reference-counted things properly.

Use the correct functions, which really are available in both versions,
so we can eliminate some ifdeffery.

Also restructure `decoder_pad_arrived' to not leak the new pad's caps.

server/gstdecode.c: With GStreamer 0.10, borrow the existing caps.

Otherwise we'd leak them.

debian/: Rewrite using Debhelper.

The old `debian/rules' was a nightmare.  Modern Debhelper is really
quite pleasant, and makes short work of jobs which the old do-it-all-by-
hand script made a horrible meal out of.  Really, the diffstat summary

29 files changed, 146 insertions(+), 440 deletions(-)

says everything I need to know.

Being fair, though, this is quite an overhaul, but I've tried hard to
minimize the fallout.  These are the user-visible changes that I'm aware
of.  Any other changes are unintentional bugs.

  * The `disorder-server' cron script has changed name from
    `/etc/cron.daily/disorder' to `.../disorder-server'.  I could have
    avoided this, but I decided that it was actually better like this.
    The package scripts include the necessary machinery for renaming the
    configuration file.

  * I'm using `dh_installdocs' now, and it has its own heuristics about
    whether to compress documentation files.  As a result, a number of
    the smaller files in `/usr/share/doc/disorder' are no longer
    compressed.  Maybe some users will have to adjust bookmarks or
    something; if this breaks scripts, then I'm afraid that dealing with
    the wreckage is what you signed up for when you wrote those scripts.

Internally, the differences are more significant.

  * A number of affordances for configuring the Debian build have been
    removed or changed; I'm not going to make a list, mostly because the
    `debian/rules' file is now so trivial.  I'm inclined to say that
    retaining these would have been a bad idea.  I view the Debian
    packaging as a route to a stable, standard binary package, best
    built in a fresh, clean, minimal environment provided by something
    like `sbuild'.  I don't object to nonstandard packages at all: I
    just think they're best made and maintained by actually patching the
    code.

  * I've added `#DEBHELPER#' markers to the package scripts, and deleted
    some of the smaller ones entirely.  Debhelper doesn't make a whole
    lot of difference to the `disorder-server' postinst script, which is
    the big one, but losing the `disobedience' scripts is a clear win.

  * Debhelper wants to run `make check' during the package build.  I
    think this is a good idea, but it involves a little extra work.
    Because `sbuild' by default forces `LC_ALL' to `POSIX', the
    `queue.py' test fails about half the time; overriding `LC_ALL' to
    `C.UTF-8' in `debian/rules' hacks around this.  The `t-addr' library
    test wants to check resolution of service names, which introduces a
    build-dependency on `netbase' to provide `/etc/services'.  I would
    have had to include a dependency on `wget', but I chose to include
    the necessary test files inline instead.

libtests: Include the Unicode test files directly.

Rather than fetch the files using `wget' at test time, fire up `gzip' to
decompress them from local copies.  The files compress really rather
well, so this is an overall saving in disk space relative to the
previous version -- especially since we now share the test files among
all build trees rather than having a separate copy in each.  On the
other hand, they're moderately large things to have in the source
distribution, though small compared to the `images/' tree.

Of course, the main reason for doing this is to completely eliminate the
need for external network connectivity during a build.

The copyright notice, at https://www.unicode.org/copyright.html, appears
to be compatible with the GPL (which is good, because I think we'd have
had a problem using these files even if we didn't distribute them).
I've included the copyright notice as COPYING.unicode-tests, in order to
comply with requirement (a).

Should it be necessary to update the copies of the test files, there's a
(slightly hairy) make target `update-unicode-tests' which can be invoked
by hand to do this.

README: Update my copyright claim.

debian/rules: Omit disorder-gstdecode(8) from `disorder-server' package.

Otherwise it turns up in two packages, and there is sadness.

README: Update dependency versions.

debian/control: Include `libdb5.3' as a suitable version.

configure.ac, acinclude.m4, lib/regexp.[ch]: Support `libpcre2'.

This is the future of `pcre', so we'll have to support it sooner or
later.  Indeed, I think this probably counts as `later'.

Concentrate knowledge about the `pcre' API in one place.

Introduce a new `regexp' API in the library which knows about `pcre' and
actually invokes `pcre_...' functions.  Remove this knowledge from
everywhere else.

The new API is, of course, suspiciously similar to `pcre' in many ways,
but there are some differences.

  * Sizes, lengths, and offsets, are all `size_t' now.  In particular,
    this means that the `ovector' type has changed.

  * Errors are reported differently: rather than returning a pointer to
    a static string, `regexp_compile' writes the error string into a
    caller-provided buffer.

Observant readers might notice that these changes make the interface
more similar to the `pcre2' API.  They'd be right, and this is not a
coincidence.  But for now, there's no functional change.

Remove ifdeffery for `HAVE_PCRE_H'.

This isn't actually an optional extra: the build simply won't work
without it, so the ifdeffery is just unnecessary complication.  Remove
it all.

Also, remove `#include <pcre.h>' from files which don't actually need
it.

configure.ac, server/gstdecode.c: Support GStreamer 1.0.

I currently don't have plans to drop support for GStreamer 0.10, though
the differences are quite significant.

configure.ac, server/Makefile.am: Refactor GStreamer autoconfery.

  * Introduce `--with-gstreamer=VERSIONS' configure option, which
    searches for the (space-separated) VERSIONS in order.

  * Pick up the `gstapp' and `gstaudio' libraries from `pkg-config'
    rather than probing randomly at `gstreamer-plugins-base-0.10' and
    hoping for the best.

  * Define a preprocessor symbol explaining which version we found.

server/gstdecode.c: Limit the buildup of internal buffers.

Block upstream decoding if we start to build up too many buffers
(presumably because downstream is waiting for real time to pass while it
plays audio at us).

The magic number 16 is plucked from nowhere in particular.  I have no
idea how to choose a number properly.

server/gstdecode.c: Add `-s' option to omit DisOrder's usual framing.

The result can be piped into something like

play -b16 -c2 -esigned-integer -r44100 -L -traw -

to verify that its output approximates decoded audio.

doc/disorder-gstdecode.8.in: Typeset option dashes correctly.

tests/dtest.py: Refer to the home directory via a symlink.

Pathnames during `make distcheck' are remarkably long, even if the
original project path is very short.  Indeed, the previous change which
added the test name into the `testroot' path is enough to push the
server's socket name over the magic 108-byte limit.

As an additional hack, arrange to refer to the home directory via a
symbolic link in `/tmp' (or wherever $TMPDIR points), which should be
much shorter.  The symlink is deleted on test completion, because
otherwise we'll fill up `/tmp' with cruft, but I hope this doesn't cause
too much in the way of diagnostic trouble.

tests/dtest.py: Maintain a separate test root for each test.

Now they can run in parallel without breaking each other, which is nice.
It's nice for two reasons: firstly, Automake changed behaviour and runs
tests in parallel by default nowadays; and secondly, the tests are
rather slow because they involve a bunch of waiting around for things,
and waiting for stuff in parallel is easy.

The downside is that we end up gobbling a lot of disk space with all of
the logfiles.  I think this is a good trade.

server/Makefile.am: Link `disorder_gstdecode' with `-lpcre'.

Linkers which don't transitively follow shared-library dependencies
complain.  This is fair enough, because there's a real direct dependency
here.

disobedience/misc.c: Muffle warning about `gdk_pixbuf_new_from_inline'.

Maybe we should use GResource at some point, but (a) it involves some
awful XML disaster, and (b) it's looking like way more effort than I
want to spend right now.

lib/configuration.c: Remove `type_stringlist', which nothing was using.

configure.ac: Link `-lgc' when searching for `GC_mumble' functions.

Otherwise we can't find them and fall back to using deprecated things.
This is a shame.

README, debian/control: Deprecate `sox' support.

sox introduced yet more command-line options in 14.2, whinges about the
old ones in 14.4, and threatens to remove them in 14.5 (because
obviously compatibility between minor versions is an old-fashioned idea
whose day is long past).

Rather than chase this obnoxiously moving target,

  (a) report that sox support is deprecated and will be removed in some
      future major version of DisOrder; and

  (b) have the Debian package Build-Depend on `libsamplerate0-dev' so
      that at least Debian users don't have to put up with sox's moaning
      in the logs.

Reported-by: Ross Younger

README: Mention optional support for GStreamer.

debian/etc.disorder.config: Remove bogus `trust root' line.

The `trust' option was removed in 657fdb79cbec..., but the default
Debian configuration wasn't changed to match.  Fix this.

Reported-by: Ross Younger

Email address

Update .gitignore

Replace code.google references with github references

Fix `distcheck' complaints.

  * Have `disobedience/Makefile.am' remove the images and desktop file
    it installs.

  * Remove `lib/versionstring.c' as well as its header file during
    clean.

  * Move source files (but not headers) from `lib/' to new `common/'
    directory if they're needed by other directories, and refer to them
    via the `VPATH' feature rather than using explicit pathnames.  (It
    doesn't work to have the whole of `lib/' on the VPATH because there
    are files in some of the other directories with the same names,
    which breaks in-tree builds.)

disobedience/disobedience.c: Show track title (or excuse) in title.

This doesn't do a great deal of good when the window is mapped.  But, in
some window managers at least, the title can be seen in a tooltip or
similar when the window is iconified or otherwise not visible.

Merge branch 'mdw/gstdecode'

* mdw/gstdecode:
  Add documentation and administrivia about `disorder-gstdecode'.
  server/gstdecode.c: Produce the configured sample format directly.
  server/gstdecode.c: Allow user to tweak the various parameters.
  server/gstdecode.c: New program, like `disorder-decode'.

Conflicts:
.gitignore
CHANGES.html
README
debian/control

CHANGES.html, README: Update the administrivia.

debian/control: Add Build-Depends for PulseAudio.

It really won't build without; and it probably shouldn't.

Add documentation and administrivia about `disorder-gstdecode'.

lib/cgi.c (cgi__input): Write terminating null within allocated buffer.

This one's been there forever.  It sometimes results in `malloc'
reporting a (rather impressive) assertion failure

disorder: malloc.c:3096: sYSMALLOc: Assertion `(old_top ==
(((mbinptr) (((char *) &((av)->bins[((1) - 1) * 2])) -
__builtin_offsetof (struct malloc_chunk, fd)))) &&
old_size == 0) || ((unsigned long) (old_size) >=
(unsigned long)((((__builtin_offsetof (struct malloc_chunk,
fd_nextsize))+((2 * (sizeof(size_t))) - 1)) & ~((2 *
(sizeof(size_t))) - 1))) && ((old_top)->size & 0x1) &&
((unsigned long)old_end & pagemask) == 0)' failed.

often after producing the beginning of the output page, so the end user
gets a blank window.  Not really what we want.

This fix closes issue #57.

disobedience/choose-search.c: Fix segfault when search terms change.

The observed problem:  Sometimes, when typing search terms into the box,
DisObedience crashes.  This seems to happen more often when the server
is slow to respond.

Here's what's going on.  Suppose that a search finds some results.  Then
`choose_make_visible' tries to expand the tree to display them.  If some
of the results aren't populated in the tree yet, then
`choose_make_one_visible' arranges to fetch the necessary information
from the server and informs its caller, `choose_make_visible', that
it'll have to try again later.  When this happens, `choose_make_visible'
hooks itself onto the `choose-more-tracks' event and waits for the
information to arrive.

Suppose that, while this is happening, the user edits the search terms;
a new search starts, but this one returns no results.  Then
`choose_search_completed' zaps the `choose_search_results' vector and
returns.

Now the metadata from the old search arrives from the server;
`choose_make_visible' is called back.  There are now no search results,
so it thinks its work is done and tries to scroll the list widget so
that the first result is visible -- but the result vector has been
clobbered.  Result: misery.

To fix this, cancel the `choose-more-tracks' event handler when a new
search finishes.  Now we can't get into this situation any more.

cgi/actions.c, lib/client*.[ch]: Don't use priv connection to check passwd.

If the CGI runs as the main `jukebox' user, then it can connect using
the special `.../private/socket', and the `find_server' function
arranges to do this if it can and no network address has been assigned
in the configuration.

The server doesn't bother to check passwords from clients on privileged
connections.  The result is that if the CGI program runs as the
`jukebox' user, its attempt to check the end-user's password through the
usual login machinery is stymied, since the library automatically sets
up a privileged connection and then the server ignores the password
entirely.  The end result is that, if you set things up in this way,
anyone can log into the CGI program with any known user and any password
at all, at which point they're given a cookie which can be used in
direct communication with the server.

Fix this as follows.

  * Introduce a new version (in the correct namespace for a change) of
    `find_server' which accepts some flags to guide the choice of server
    addresses.

  * Add a flag for the new `disorder_find_server' function to prevent
    trying the privileged socket.

  * Add a function to the client interface (and a bit of state to the
    client structure) to instruct the connection functions not to use a
    privileged connection even if they can.

  * Get the CGI program to use this new function when logging in with a
    password, so that it will always be checked.

Cookies are checked properly, even from privileged clients, so there's
nothing to fix there.

scripts/sedfiles.make, doc/disorder.cgi.8.in: Say where the file is.

The manpage used to say that the Makefile doesn't install the CGI
program anywhere, which hasn't been true for a while.  Remove the old
lies and just say where it was put.

configure.ac, lib/mem.c: Compatibility with older versions of libgc.

The `GC_get_all_interior_pointers()' function and its friends were
introduced after the libgc in Debian wheezy (which is quite impressive
seeing as they were added in 2009).  Make sure it's there; use the old
now-deprecated variable directly if it isn't.

Respond to libgc deprecation warning

Add nonnull attribute to a few function args.

Tinker with loop bounding to placate GCC 5.2.1

gzip -n in aid of reproducible builds

Warning tidy-up for FreeBSD.

- if dlfunc is available use that. Allows -Werror to be re-enabled.
- use modern struct member initializers
- cope with FD_SETSIZE being explicitly unsigned
- remove stray brackets
- remove unused objects
- use %ju to print sig_atomic_t, it might be bigger than int

Assign default http/cgi directories

FreeBSD doesn't have IFF_DYNAMIC

FreeBSD fixes

Update list of libdb versions.
Bodge in -liconv.

Placate gcc -flto

I don't think either of these are real bugs, but it keeps the compiler
happy.

init: source lsb init functions

Placates lintian a bit.

Suppress bogus doc-base registration warnings from lintian.

Remove redundant entry from .desktop file

Enable hardening flags harder.

Now with a workaround for broken GCC diagnostic.

debian: use debian compiler flags

debian: don't depend on essential packages

disorder.h: more consistent approach to function attributes

gitignore

tests: python unbuffered revisited

Set AUTOMAKE_OPTIONS=subdir-objects where necessary.

Windows support for command line client

Non-ASCII characters not properly supported.

Provide for a network initialization step

table search: cope without typeof

Remove some redundant includes.

Add uint16_t if missing.