Merge topic branch t/sched into pu

Started on 2025-06-01

* refs/heads/t/sched:
  server: Kill global variable sched.
  Make struct sched private.

# Conflicts:
# sched.h

Merge topic branch t/misc into pu

The stuff in here is too small to get its own topic branch. The
commits are generally regarded as safe enough to be applied directly to
"master" without cooking in "next" first. However, if a commit induces
a merge conflict or is important enough to get mentioned in an item
of the NEWS file, the commit should get a dedicated topic branch.

Unlike most other topic branches, this branch never promotes to
"next". When a set of commits is ready to graduate to "master", the
branch is rebased onto "master" and its commits are re-ordered so that
the graduating commits appear at the beginning. The last such commit
is merged to "master". This always results in a fast-forward merge,
so no merge message needs to be supplied.

<!-- No merge message -->

* refs/heads/t/misc:
  Move FOR_EACH_RECEIVER from recv.h to recv_common.c.
  send_common.c does not need afs.h.
  Speed up blob operations.
  vss: Make vss_next() and vss_repos() static.
  vss: Change vss_playing() and friends to return bool.
  wma: Use unsigned byte arrays.
  sched.h: Remove an unnecessary declaration.
  server: Delay vss shutdown in command handler context.

# Conflicts:
# sched.h

Merge topic branch t/doxygen into pu

This revamps the doxygen part of the documentation web page, adding a couple
of entry points for users to get started with the code base. We provide links
to header files which descripe the API of central subsystems and links to
the main file of each paraslash executable.

The \file comment of the source files reachable through these links have been
extended to contain a detailed description of the API or executable. Unlike
the introductory text of the manual pages, these comments focus on the code,
particularly the interaction between the various subsystems.

This also reactivates the source browser, since it is actually quite useful
to quickly check for some detail.

<!--

- Major revamp of the source code documention and the documentation web page.

-->

* refs/heads/t/doxygen: (38 commits)
  crypt
  gui
  doc-page
  f
  filter api
  recv
  afs
  afs
  afs
  fec
  doc-site
  send.h
  senders
  send/source-browser
  write
  afh
  afh.h
  f
  afh
  Move detailed desc to top
  ...

# Conflicts:
# crypt.h

Move FOR_EACH_RECEIVER from recv.h to recv_common.c.

It called twice from there but from nowhere else.

send_common.c does not need afs.h.

Fixes: 2abba90245f87fab096edfc3faf7df61646b713f

Speed up blob operations.

The current status items are unaffected by any blob operations, so this code
is completely unnecessary.

vss: Make vss_next() and vss_repos() static.

Unlike vss_playing(), vss_paused() and vss_stopped(), these are only called
from within vss.c.

vss: Change vss_playing() and friends to return bool.

All users are in boolean contexts.

wma: Use unsigned byte arrays.

They get initialized with values which cause an overflow on systems where
char is signed.

sched.h: Remove an unnecessary declaration.

server: Delay vss shutdown in command handler context.

The sender status subcommand invoked via ->handle_connect() accesses memory
that has been freed in vss_shutdown(), resulting in garbage output. This
use-after-free bug is correctly reported by valgrind. It can easily be fixed
by moving the vss_shutdown() call down.

Fixes: 018a7b7927b76044b28eece39039cb2f5ea9c192

crypt

gui

doc-page

f

filter api

recv

afs

afs

afs

server: Kill global variable sched.

Make it local to main() and pass the pointer to the few functions that need it.

Make struct sched private.

This moves the declaration of the structure from sched.h to sched.c because
the information stored in this structure has almost no users outside of the
scheduler core.

As a result, the size of the structure is no longer known outside of sched.c.
Applications now must call the new sched_new() to obtain a pointer to an
initialized scheduler structure, passing an alternative poll function if
needed. We don't let applications set the default timeout anymore because
the value is kind of arbitrary anyway and most applications simply specified
one second. So hardcode this as the default.

fec

doc-site

Merge branch 'master' into next

* master:
  i9e: Constify completer arrays.
  Prefer __func__ to __FUNCTION__.
  imdct: Kill fftsample_t typedef.
  Doxgen: Do not omit brief descriptions.
  fd: Modify xwrite() and write_all() to take void * buffer argument.

# Conflicts:
# interactive.h

send.h

senders

send/source-browser

write

afh

afh.h

f

afh

Move detailed desc to top

layout

.

.

.

.

.

.

.

dox

dox

recv.c: Do not include fd.h

doxygen

dox

doxygen

Revamp documentation of filter.c

doxygen: Hide undocumented members.

css: Remove a lot of unused cruft.

None of these are actually used in the pages generated by doxyen-1.8.

doxygen: Use a more sane default output directory.

Put the pages below build/ so that make distclean removes them.

i9e: Constify completer arrays.

This way the array of completers goes into the rodata section.

Prefer __func__ to __FUNCTION__.

The former is part of the C99 standard, while the latter is only provided
for backward compatibility. This change also silences many gcc warnings when
compiling with -Wpendantic (disabled in the default build).

imdct: Kill fftsample_t typedef.

There is no advantage in not using plain float here.

Doxgen: Do not omit brief descriptions.

Commit 3107d2411a7a was a bit overzealous because with BRIEF_MEMBER_DESC
and REPEAT_BRIEF both set to NO the short text does not even make it into
the detailed description. This was unintended, so partially revert this change.

Fixes: 3107d2411a7a8f4085d0db65851483f2cb3c4f6e

fd: Modify xwrite() and write_all() to take void * buffer argument.

That's what the underlying call to writev(2) expects.

Merge branch 'master' into next

* master:
  net.c: Convert SS_IS_ADDR_V4MAPPED() to lower case.

Merge topic branch t/wmadec into master

A few patches which remove unused code from the wma decoder and audio
format handler. Notably, noise coding was removed completely since
it was only used for unusual bit rates. Most likely, it never worked
in the first place.

* refs/heads/t/wmadec:
  wmadec: Fix typo in comment.
  wmadec: Remove a stale comment in wma_init().
  wmadec: Kill pointless start/end computations.
  wmadec: Remove noise coding.
  wmadec: Simplify wma_init().
  wmadec: Remove fft().

net.c: Convert SS_IS_ADDR_V4MAPPED() to lower case.

It's not a macro, after all. Remove the superfluous braces and fix
a whitespace issue while at it.

Merge branch 'master' into next

* master:
  Shrink struct rmatt_event_data.
  filter.c: Constify dummy variable.
  filter.c: Remove unused status_item_list[].
  audiod.c: Make slots[] static.
  server.c: Remove unused server_get_tasks().

Shrink struct rmatt_event_data.

The aft event handler needs to know the bit number of the attribute which is
being removed in order to clear the bit in the afs info structure of each row
of the audio file table. The handler does not need to know the attribute's
name, though, and remove_attribute() already prints it, so remove this field
from the event data structure.

filter.c: Constify dummy variable.

It needs to be non-static, but it may be const because the amp filter
only reads the values of this array.

filter.c: Remove unused status_item_list[].

para_filter does not need this at all, and never has, afaict.

audiod.c: Make slots[] static.

It's only used in audiod.c.

server.c: Remove unused server_get_tasks().

The last caller was removed when the tasks server subcommand was disabled
eight years ago.

Fixes: bb91597b9ecf650a63a40753f7f7c771576d252e

Merge branch 'master' into next

* master:
  css: Remove memItem tweaks.
  css: Fix a typo in comment.
  fec.c: Remove an unused #include.
  Move public key to web/.
  INSTALL: Remove installation instructions of lopsub.
  http sender: Kill pointless macro.

Merge topic branch t/select- into master

A single patch which implements the new "select -" feature to switch
back to the previous mood or playlist.

* refs/heads/t/select-:
  com_select(): Support '-' to reactivate the previous mood/playlist.

css: Remove memItem tweaks.

The pages look better without this since the tables no longer contain
horizontal lines above all entities.

css: Fix a typo in comment.

fec.c: Remove an unused #include.

The fec code does not need the helpers from portable_io.h.

Move public key to web/.

It's only needed for the web pages, so it should not be contained in the
top-level directory.

INSTALL: Remove installation instructions of lopsub.

These days, people should just install the Debian package. If lopsub is not
installed, the configure script prints detailed instructions about how to
obtain lopsub with and without apt.

http sender: Kill pointless macro.

The code is shorter and easier to read without the macro.

Merge branch 'master' into next

* master:
  Introduce VSS_NEW_AUDIO_FILE to fix playlist updates.

Introduce VSS_NEW_AUDIO_FILE to fix playlist updates.

The playlist event handler handles afsi change events by moving the affected
entry to the end of the playlist. This is the right thing to do if the
event was triggered by virtual streaming system streaming a new file. It is
incorrect, however, if the event was triggered by a subcommand such as touch.

This commit introduces the new afs event type VSS_NEW_AUDIO_FILE to distinguish
between the two different use cases. The audio file table event handler
ignores the VSS_NEW_AUDIO_FILE event while the playlist event handler ignores
the AFSI_CHANGE event. The moods event handler treats both events equally,

Get rid of a pointless static one-liner function in playlist.c while at it.

Merge topic branch t/wmadec into next

Started on 2025-01-22

A few patches which remove unused code from the wma decoder and audio
format handler. Notably, noise coding was removed completely since
it was only used for unusual bit rates. Most likely, it never worked
in the first place.

* refs/heads/t/wmadec:
  wmadec: Fix typo in comment.
  wmadec: Remove a stale comment in wma_init().
  wmadec: Kill pointless start/end computations.

Merge topic branch t/deprecate_setatt into next

A single patch which deprecates the setatt server subcommand. This subcommand
fails, for example, if the name of an audio file happens to end in '+'
or '-'. The replacement for setatt are the two new options to the touch
subcommand to set or unset attributes.

* refs/heads/t/deprecate_setatt:
  server: Deprecate setatt in favor of touch.

Merge branch 'master' into next

* master:
  aft: Pass correct afsi argument to AFSI_CHANGE event handlers.

Merge topic branch t/rm_sha1 into next

The series first drops the para_upgrade_db executable because it is no longer
needed. This removes the penultimate user of the sha1 infrastructure. The
remaining user is the handshake between para_client and para_server.

Since paraslash-0.7.0, client and server employ sha256 by default, but fall
back to sha1 in order to stay compatible to old 0.6.x versions. This series
instructs server and client to always employ sha256 as the hash algorithm,
breaking compatibility with 0.6.x clients. As a result, the sha1 hash algorithm
is no longer used anywhere, so the corresponding infrastructure is no longer
needed. This gets rid of a fair amount of code.

<!--

- The para_upgrade_db executable to convert old paraslash databases has
been removed. paraslash-0.7.0 was released more than three years ago, so
everybody should have upgraded by now.

- Authentication now rejects the weak sha1 hash algorithm, breaking
compatibility with 0.6.x versions. Older 0.7.x clients are still compatible
to current server versions and current clients can still talk to servers
running older 0.7.x versions.

-->

* refs/heads/t/rm_sha1:
  Rename hash2 -> hash.
  Remove sha1.
  Remove para_upgrade_db.
  aft: Compare the full hash, not just the first 20 bytes.

Rename hash2 -> hash.

Now that sha1 is no longer supported, the hash2 naming has become meaningless.
Rename it back to "hash".

Remove sha1.

Server and client prefer sha256 in the authentication protocol since
paraslash-0.7.0, while 0.6.x clients and servers only know about sha1. This
patch drops the compatibility code which enabled old clients to connect to
new servers and vice versa.

Now the client code no longer checks whether the sha256 feature is supported,
but requests and uses the feature unconditionally. The server still announces
the sha256 feature and accepts the corresponding feature request, but uses
sha256 unconditionally.

With this approach older 0.7.x clients are still compatible to current
server versions and current clients can still talk to servers running older
0.7.x versions.

Merge branch 'master' into next

* master:
  Improve documentation of set_max_chunk_size().
  Warn about old (0.5.x or earlier) on-disk afhi.
  doxyen: Completely suppress brief descriptions.
  buffer_tree: Assert that we don't pass NULL to memcpy().
  mp.c: Remove a dead store.
  mood.c: Remove a dead store and fix the documentation of mood_load().
  flac_afh: Check for possible integer overflows.
  gcc-compat.h: Drop inline #define.

Remove para_upgrade_db.

It is no longer needed since everybody should have upgraded by now, and it
blocks the road towards the removal of sha1.

aft: Compare the full hash, not just the first 20 bytes.

In 0.7.0 the hash algorithm for the hash column of the audio file table
changed from the 20 byte sha1 to the 32 byte sha256. However, the audio file
selector kept calling hash_compare() as the comparator, which looks only at
the first 20 bytes of the buffers passed.

This omission is clearly a bug, but given that we still accept old clients
which only know about sha1, it's benign because the truncated sha256 should
not be worse than sha1. Fix the bug anyway.

Fixes: 126b950f1bd70d1e5c200bc4157bbbb2798fc838

aft: Pass correct afsi argument to AFSI_CHANGE event handlers.

Each time a new audio file is opened for streaming, we update the numplayed
and lastplayed fields of its afs info entry of the audio file table, then
update the global afsi and ahfi structures, then trigger an AFSI_CHANGE event,
which calls all table event handlers. The event handlers receive as arguments
a pointer to the old afsi and a pointer to the already modified aft row.

The AFSI_CHANGE event handler of the audio file table gets called in the
situation described above, and also via the touch and cpsi subcommands,
because these also change the afsi info structure and therefore trigger
AFSI_CHANGE events as well. The handler checks whether the affected audio
file is the current audio file, and if it is, extracts the modified afsi
from the audio file table into the global afsi structure.

The problem is that in case of the above "next audio file" scenario, the
old afsi pointer points to the global afsi structure, which gets updated
by the aft event handler. Therefore the event handlers which happen to run
after the event handler of the audio file table see the already updated afsi
through the old_afsi pointer.

Since the audio file table happens to be the first table of the 7-element
afs_tables[] array iterated by afs_event(), all six other event handlers see
the incorrect afsi. However, only the moods event handler looks at the old afsi
to update the mean and quadratic variation of the lastplayed and numplayed
values of the afs statistics. Due to the bug described above, the old and
new lastplayed and numplayed values coincide, and therefore the statistics
update is a no-op. In practice, at least for moods with many admissible files,
the values will only be slightly off, so the bug is rather benign.

Fix this by renaming the on-stack new_afsi to old_afsi, adjusting
initializations accordingly, and passing a pointer to this instance instead.

Improve documentation of set_max_chunk_size().

The old text implied that the function could be removed at some point, which
is not the case. Remove this part of the documentation and clarify what the
function actually does.

Warn about old (0.5.x or earlier) on-disk afhi.

Nine years ago, starting with commit 234647bb5, old on-disk entries are
reported with a notice to re-add the file in order to update the audio file
table. Bump the loglevel for now, and add a comment to turn the check into
a hard error eventually.

doxyen: Completely suppress brief descriptions.

This shortens the doxygen pages, removing lots of pointless duplications.

buffer_tree: Assert that we don't pass NULL to memcpy().

The buffer pointer cannot be NULL here because this only happens when the
buffer tree area is full, which is not the case thanks to the previous n <=
btr_pool_unused(btrp) check.

mp.c: Remove a dead store.

Found by the clang analyzer.

wmadec: Fix typo in comment.

wmadec: Remove a stale comment in wma_init().

Noise coding has been removed.

Fixes: 9fe8a674535a00c6011f86b4ece3344200d00aa2

Merge branch 'master' into next

* master:
  play.c: Kill pointless typedef.
  afs.h: Omit superfluous semicolons.
  Makefile: Drop redundant -Wuninitialized.

mood.c: Remove a dead store and fix the documentation of mood_load().

The function returns 1 on success, not the number of admissible files.

Found by the clang analyzer.

flac_afh: Check for possible integer overflows.

This is a callback function which should carefully check its inputs.

gcc-compat.h: Drop inline #define.

There is no reason to believe that the programmer does a better job than
the compiler here.

wmadec: Kill pointless start/end computations.

Neither start nor end are used. The loop simply adds up the entries of one
line of the exponent_bands matrix.

Found by the clang analyzer.

play.c: Kill pointless typedef.

The signature of the function pointer is too simple to warrant a typedef.

afs.h: Omit superfluous semicolons.

The DECLARE_BLOB_SYMBOLS macro expands to a bunch of declarations, each of
which is terminated by a semicolon. So don't add another one.