In Z_UpgradeDatabase.php, rendered "Update Description" is incorrect

[dalers]

I first noticed this a few months back.

I wonder what string is incorrectly manipulated and how.

[timschofield]

Hmmm, it looks OK on my system

What does your line 91 of Z_UpgradeDatabase.php say?

[dalers]

Hi @timschofield

Z_UpgradeDatabase.php lines 86-99 (the entire If). I believe it is identical to the latest in the repo.

			if (preg_match_all($pattern, $Contents, $Matches) and (implode("\n", $Matches[0]) != "UpdateDBNo(basename(__FILE__, '.php'));")) {
				/// @todo use more regexps to extract the upgrade description rather than using substrings
				echo '<tr>
					<td><span class="expand_icon" id="expand_icon', $x, '"></span></td>
					<td>', $UpdateNumber, '</td>
					<td>', substr(substr(implode("\n", $Matches[0]), 44), 0, -4), '</td>
				</tr>';
			} else {
				echo '<tr>
					<td><div class="expand_icon" id="expand_icon', $x, '"></div></td>
					<td>', $UpdateNumber, '</td>
					<td>', __('No descriptrion can be found for this update'), '</td>
				</tr>';
			}

[dalers]

I've checked and can confirm now that my Z_UpgradeDatabase.php is identical to that in the repo.

[dalers]

P.S. I'm using PHP 8.2 in XAMPP on Windows.

[dalers]

I can't say these are related, but I also noticed the following:

1. if there is a comment line after the UpdateDBNo() call in an update script (e.g. 32.php), the Update Description in the table appears to be the intended update description concatenated with the comment line.

2. the "maintenance" icon seems to be missing from the rendered page. I didn't follow the file paths, but my user is using the Xenos theme and there is no sign of a "gear" icon (maintenance.png) on the rendered page (fwiw xenos is $DefaultTheme in config.php).

[timschofield]

Hi Dale,

I think this is to do with windows line ending characters. Can you try replacing line 91 with:

', str_replace(array("\r", "\n"), '', substr(substr(implode("\n", $Matches[0]), 44), 0, -4)), '

and see what happens?

Tim

[dalers]

Still experimenting....

There's seems to be a cached variable affecting things. I edited the upgrade description and deleted the commented following line from upgrade 32.php and refreshed the browser page, the update description includes both the edit made as well as the following commented line. Huh???

Deleted all third-party cookies, forced browser cache reset, simplified upgrade description (removed commas and brackets around "(pt 1)" and the page still isn't rendering correctly. Now it seems the upgrade description in the table is the string from the UpdateDBNo() call concatenated with itself but there's also a "\" appearing before the start of the update table. Huh???

[dalers]

P.S. The last screenshot was with the code change you suggested to Z_UpgradeDatabase.php

I then restarted Windows and XAMPP, deleted my update 32.php, and reverted the database to prior to update 31. After logging in, the upgrade system ran Z_UpgradeDatabase.php and showed:

[timschofield]

Sorry that change should have read:
<td>', str_replace(array("\r", "\n"), '', substr(substr(implode("\n", $Matches[0]), 44), 0, -4)), '</td>

[timschofield]

I have improved this a bit:

$Description = str_replace("\r", '', $Matches[0]);
echo '<tr>
<td><span class="expand_icon" id="expand_icon', $x, '"></span></td>
<td>', $UpdateNumber, '</td>
<td>', substr(substr(implode("\n", $Description), 44), 0, -4), '</td>
</tr>';

I have tested this by changing the line endings to windows style and this works with both Unix and windows styles.

Tim

[dalers]

Thanks @timschofield. I can confirm now this has resolved the issue for me too. :-)