Zend OPcache API is restricted during upgrade 2.8 - 3.0beta1

[eydolan]

Bug report

Summary

When trying to upgrade 2.8.3 to 3.0.0 beta1 itt gives me OPcache API error

Step to reproduce

copy all new files over old ones,
run setup
get
Warning: Zend OPcache API is restricted by "restrict_api" configuration directive in /usr/www/users/XXX/setup/includes/modinstallsettings.class.php on line 97
Warning: Zend OPcache API is restricted by "restrict_api" configuration directive in /usr/www/users/XXX/setup/includes/modinstallsettings.class.php on line 97
Warning: Cannot modify header information - headers already sent by (output started at /usr/www/users/XXX/setup/includes/modinstallsettings.class.php:97) in /usr/www/users/powerycwff/setup/includes/request/modinstallrequest.class.php on line 232

cache was manually deleted before upgrade attempt

Observed behavior

error and can not carry on install

Expected behavior

should complete install

Related issue(s)/PR(s)

n/a

Environment

apache
php 7.4 and 8.0
mariaDB

[garryn]

What's your setting for opcache.restrict_api in your php.ini (or, to check, use phpinfo)?

[eydolan]

its
opcache.restrict_api | /var/www/default | /var/www/default

[garryn]

Ok, after a bit of research .. sounds like we need an additional check in modinstallsettings.class.php at line 97 where the opcache_invalidate function is checked to also check the validity of the opcache.restrict_api value.

[eydolan]

I dont recall this error happening on alpha release

I stand corrected same thing happens on alpha 3

[opengeek]

Ok, after a bit of research .. sounds like we need an additional check in modinstallsettings.class.php at line 97 where the opcache_invalidate function is checked to also check the validity of the opcache.restrict_api value.

What do you mean by check the validity? If the PHP configuration is invalid, why is that something the software needs to detect here?

[Mark-H]

I think by checking validity Garry probably means checking if the filename is in the path allowed to run the opcache commands. Kinda like open basedir checking?

[opengeek]

I think by checking validity Garry probably means checking if the filename is in the path allowed to run the opcache commands. Kinda like open basedir checking?

If that is the case, why should MODX be checking if you misconfigured your OPCache configuration? That's what I'm asking.

[Mark-H]

Is it _mis_configured, though? I'm not super familiar with opcache but I don't see why /var/www/default is an invalid path to put in that option. Even if that's not where the site is located causing the warning; that path might serve up a custom page to clear the opcache.

[opengeek]

Is it _mis_configured, though? I'm not super familiar with opcache but I don't see why /var/www/default is an invalid path to put in that option. Even if that's not where the site is located causing the warning; that path might serve up a custom page to clear the opcache.

If it is a valid path, then why is it an issue? I am so confused.

[opengeek]

And by valid, I mean a path that includes where setup is running. We could try to detect if it is within the path, but that could potentially return false failures. It just seems like an odd corner case to be trying to handle automatically, but I'll let others decide.

[eydolan]

I am also not sure but I been using same php settings on modx 2 and no issues it installs fine, hence I posted this because I did not come across this before why 3 is giving an error.

[eydolan]

modx 3 alpha 1 works fine

[eydolan]

Some feedback from server admin:
_opcache.restrict_api value is set to /var/www/default as a default server configuration.

This is done to increase security on the servers (this is the hosting company)

We would suggest using the workaround to suppress the exception by adding a “@” to your code where you work around the restricted_api. Usually, this error specifies the exact file on a specific line, where you would add the “@” in front of the code._

So all they are suggesting is just to suppress the error message not sure if that is ideal....

This is all they said. I am sure other hosting companies will have a similar setup.

[garryn]

Suppressing the error is not ideal. Checking the path in opcache.restrict_api prior to calling opcache_invalidate() is better.