Change logging date formatting string from strftime() to date().

thijskh · thijskh · commit dfbb7e65f412 · 2022-02-06T09:31:11.000+01:00
strftime is deprecated and will be removed in PHP 9. SSP 2.0 is our
chance to change this format as it's exposed to installers of SSP.

The approch is to keep it simple and just change the format to PHP's
built in date() function which remains supported. Also we do not try
to localize the logging date/timestamps anymore. This matches the syslog
approach that this format tried to mimic. We are using the day without
leading zeroes now also to be a bit closer to how syslog does it.
diff --git a/config-templates/config.php b/config-templates/config.php
@@ -302,7 +302,7 @@
      * are:
      *
      * - %date{<format>}: the date and time, with its format specified inside the brackets. See the PHP documentation
-     *   of the strftime() function for more information on the format. If the brackets are omitted, the standard
+     *   of the date() function for more information on the format. If the brackets are omitted, the standard
      *   format is applied. This can be useful if you just want to control the placement of the date, but don't care
      *   about the format.
      *
@@ -322,7 +322,7 @@
      * - %msg: the message to be logged.
      *
      */
-    //'logging.format' => '%date{%b %d %H:%M:%S} %process %level %stat[%trackid] %msg',
+    //'logging.format' => '%date{M j H:i:s} %process %level %stat[%trackid] %msg',
 
     /*
      * Choose which facility should be used when logging with syslog.
diff --git a/docs/simplesamlphp-upgrade-notes-2.0.md b/docs/simplesamlphp-upgrade-notes-2.0.md
@@ -34,7 +34,10 @@ Configuration changes
 ---------------------
 Quite some options have been changed or removed. We recommend to start with a fresh
 template from `config-templates/` and migrate the settings you require to the new
-config file= manualy.
+config file manualy.
+
+The date formatting when specifying a custom logging string has been changed from PHP's
+deprecated `strftime()` format to PHP's `date()` format.
 
 Configuration options that have been removed:
  - languages[priorities]
diff --git a/lib/SimpleSAML/Logger.php b/lib/SimpleSAML/Logger.php
@@ -91,7 +91,7 @@ class Logger
      * general the options are:
      *
      * - %date{<format>}: the date and time, with its format specified inside the brackets. See the PHP documentation
-     *   of the strftime() function for more information on the format. If the brackets are omitted, the standard
+     *   of the date() function for more information on the format. If the brackets are omitted, the standard
      *   format is applied. This can be useful if you just want to control the placement of the date, but don't care
      *   about the format.
      *
@@ -113,7 +113,7 @@ class Logger
      *
      * @var string The format of the log line.
      */
-    private static string $format = '%date{%b %d %H:%M:%S} %process %level %stat[%trackid] %msg';
+    private static string $format = '%date{M j H:i:s} %process %level %stat[%trackid] %msg';
 
     /**
      * This variable tells if we have a shutdown function registered or not.
diff --git a/lib/SimpleSAML/Logger/FileLoggingHandler.php b/lib/SimpleSAML/Logger/FileLoggingHandler.php
@@ -112,13 +112,13 @@ public function log(int $level, string $string): void
 
             $matches = [];
             if (preg_match('/%date(?:\{([^\}]+)\})?/', $this->format, $matches)) {
-                $format = "%b %d %H:%M:%S";
+                $format = "M j H:i:s";
                 if (isset($matches[1])) {
                     $format = $matches[1];
                 }
 
                 array_push($formats, $matches[0]);
-                array_push($replacements, strftime($format));
+                array_push($replacements, date($format));
             }
 
             $string = str_replace($formats, $replacements, $string);

Original file line number	Diff line number	Diff line change
`@@ -302,7 +302,7 @@`
`302`	`302`	`* are:`
`303`	`303`	`*`
`304`	`304`	`* - %date{<format>}: the date and time, with its format specified inside the brackets. See the PHP documentation`
`305`		`- * of the strftime() function for more information on the format. If the brackets are omitted, the standard`
	`305`	`+ * of the date() function for more information on the format. If the brackets are omitted, the standard`
`306`	`306`	`* format is applied. This can be useful if you just want to control the placement of the date, but don't care`
`307`	`307`	`* about the format.`
`308`	`308`	`*`
`@@ -322,7 +322,7 @@`
`322`	`322`	`* - %msg: the message to be logged.`
`323`	`323`	`*`
`324`	`324`	`*/`
`325`		`- //'logging.format' => '%date{%b %d %H:%M:%S} %process %level %stat[%trackid] %msg',`
	`325`	`+ //'logging.format' => '%date{M j H:i:s} %process %level %stat[%trackid] %msg',`
`326`	`326`
`327`	`327`	`/*`
`328`	`328`	`* Choose which facility should be used when logging with syslog.`
Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ class Logger`
`91`	`91`	`* general the options are:`
`92`	`92`	`*`
`93`	`93`	`* - %date{<format>}: the date and time, with its format specified inside the brackets. See the PHP documentation`
`94`		`- * of the strftime() function for more information on the format. If the brackets are omitted, the standard`
	`94`	`+ * of the date() function for more information on the format. If the brackets are omitted, the standard`
`95`	`95`	`* format is applied. This can be useful if you just want to control the placement of the date, but don't care`
`96`	`96`	`* about the format.`
`97`	`97`	`*`
`@@ -113,7 +113,7 @@ class Logger`
`113`	`113`	`*`
`114`	`114`	`* @var string The format of the log line.`
`115`	`115`	`*/`
`116`		`- private static string $format = '%date{%b %d %H:%M:%S} %process %level %stat[%trackid] %msg';`
	`116`	`+ private static string $format = '%date{M j H:i:s} %process %level %stat[%trackid] %msg';`
`117`	`117`
`118`	`118`	`/**`
`119`	`119`	`* This variable tells if we have a shutdown function registered or not.`
Original file line number	Diff line number	Diff line change
`@@ -112,13 +112,13 @@ public function log(int $level, string $string): void`
`112`	`112`
`113`	`113`	`$matches = [];`
`114`	`114`	`if (preg_match('/%date(?:\{([^\}]+)\})?/', $this->format, $matches)) {`
`115`		`- $format = "%b %d %H:%M:%S";`
	`115`	`+ $format = "M j H:i:s";`
`116`	`116`	`if (isset($matches[1])) {`
`117`	`117`	`$format = $matches[1];`
`118`	`118`	`}`
`119`	`119`
`120`	`120`	`array_push($formats, $matches[0]);`
`121`		`- array_push($replacements, strftime($format));`
	`121`	`+ array_push($replacements, date($format));`
`122`	`122`	`}`
`123`	`123`
`124`	`124`	`$string = str_replace($formats, $replacements, $string);`