I supplemented the existing comments on the methods in which there was not enough information to the standard phpDoc.

DokuWiki assumes that the server's time is correct. Especially page
revisions and cache handling depend on correct time. If that's not the
case it can lead to problems later (as mentioned in #1644).

This patch adds a very simple time check using the Date response header
from the DokuWiki server to our do=check mechanism.

In an older version of PHP a file_exists() call would issue a warning
when the file did not exist. This was fixed in later PHP releases. Since
we require PHP 5.3 now, there's no need to supress any error here
anymore. This might even give a minor performance boost.

that's the version in Debian old stable

this ensures there will be never, ever an outdated update message shown
after upgrade.

The existing logic for messages.txt requires some valid update
response (ending in %) to the messages update check before it clears
the current messages.

However update.dokuwiki.org appears to return an empty string response
if everything is up to date. (ie http://update.dokuwiki.org/check/46.1 )

As a result if there are update messages in messages.txt they don't
automatically go away after updating to the current version. The only
time they change is when a newer release comes out. The upgrade plugin
has logic in it to force a re-download of messages.txt, but currently
this just re-downloads the old update messages.

This change explicitly allows for "" as a valid "no messages"
indicator (distinct from false, which is the HTTP error indicator.)

This should avoid problems when a WiFi login redirect intercepts the
update check.
See https://forum.dokuwiki.org/post/45076

This introduces a new dbg_deprecated() function which allows for easy
marking of deprecated functions. Each call is logged to the debuglog
when debuggin is enabled.

Removed extraneous whitespace to eliminate errors reported by the
Squiz.WhiteSpace.SuperfluousWhitespace sniff.

for completeness (& defensive coding), test ['show'] against MSG_PUBLIC in case its redefined to a non-zero value

add capability to restrict recipients of dokuwiki 'msg' alerts.  This is useful where message is added to the queue before authentication is initialized

We now have two defines for checking for UTF-8 and Unicode property
support in PREG and use them to work around FS#2636 on older systems.

we now touch the messages before the actual update happens. this should
lower the chance of more than one update check running at a time.

these are already checked in init.php, so we can save some space here

This bug occurs on systems where writing a zero-length string to an
empty file does not update the file's modification timestamp.

This leads to the messages.txt being downloaded almost endlessly, causing
long delays for logged-in users. Visitors are not affected, because the
messages.txt is only updated for logged-in users.

With this test it should be possible to detect if the search index has
been corrupted by using Rincewind RC or a git version of the weeks
before the RC release.

This commit fixes two bugs that occurred when msg() was called after
html_msgarea() had already been called.
- the $MSG array is now cleared when it has been printed (otherwise $MSG
  has been printed again when another msg() call was done)
- headers_sent() didn't work for me, it always reported false although
  html_msgarea() had already been called which might be explainable with
  output buffering. This makes msg() now depend on the first call of
  html_msgarea() or headers_sent() in order to not to break msg() in
  ajax requests etc.

The debug log isn't automatically cleaned so don't write to it when
debugging is disabled and thus nobody is aware that debug output might
be generated.

FS#1878: Hide Dokuwiki version information from metadata and only show it to admins and manager in do=check. Also protected meta files README, VERSION and COPYING additionally to .ht*

msg() now stores always the message to the MSG array until headers are
sent. After this, a call of msg will print out all messages from the MSG
array immediately through html_msgarea.
This prevents double posting and losses of messages from the MSG array.