Wala shell

Advanced PHP File Manager

Server IP: 127.0.0.1 | PHP Version: 8.3.30 | Domains Hosted: 54

Name	Size	Last Modified
📁 ..	-	2026-03-12 22:37
📄 AjaxResponse.php <?php / ******************************************* * LiteSpeed Web Server Cache Manager * * @author Michael Alegre * @copyright 2019-2025 LiteSpeed Technologies, Inc. * @since 1.9 * ******************************************* / namespace Lsc\Wp; /* * @since 1.9 / class AjaxResponse { /* * @since 1.9 * @var AjaxResponse / protected static $instance; /* * @since 1.9 * @var string / protected $ajaxContent; /* * @since 1.9 * @var string / protected $headerContent; /* * * @since 1.9 / private function __construct() { } /* * * @since 1.9 * * @return AjaxResponse / private static function me() { if ( self::$instance == null ) { self::$instance = new self(); } return self::$instance; } /* * * @since 1.9 * * @throws LSCMException / public static function outputAndExit() { $output = ''; if ( self::$instance == null ) { throw new LSCMException('AjaxResponse object never created!'); } $m = self::me(); if ( !empty($m->headerContent) ) { $output .= "{$m->headerContent}\n\n"; } $output .= $m->ajaxContent; ob_clean(); echo $output; exit; } /* * * @since 1.9 * * @param string $ajaxContent / public static function setAjaxContent( $ajaxContent ) { self::me()->ajaxContent = $ajaxContent; } /* * * @since 1.9 * * @param string $headerContent */ public static function setHeaderContent( $headerContent ) { self::me()->headerContent = $headerContent; } }	1.79 KB	2026-03-12 22:37
📄 CliController.php <?php / **************************************** * LiteSpeed Web Server Cache Manager * * @author Michael Alegre * @copyright (c) 2018-2023 LiteSpeed Technologies, Inc. * ******************************************* / namespace Lsc\Wp; use Exception; use Lsc\Wp\Context\Context; use Lsc\Wp\Panel\ControlPanel; use Lsc\Wp\Panel\CPanel; class CliController { /* * @since 1.13.5 * @var string / const SPECIAL_CMD_CPANEL_PLUGIN_AUTOINSTALL_OFF = 'cpanelPluginAutoInstallOff'; /* * @since 1.13.5 * @var string / const SPECIAL_CMD_CPANEL_PLUGIN_AUTOINSTALL_ON = 'cpanelPluginAutoInstallOn'; /* * @since 1.13.5 * @var string / const SPECIAL_CMD_CPANEL_PLUGIN_AUTOINSTALL_STATUS = 'cpanelPluginAutoInstallStatus'; /* * @since 1.13.5 * @var string / const SPECIAL_CMD_CPANEL_PLUGIN_FIX_CONF = 'cpanelPluginFixConf'; /* * @since 1.13.5 * @var string / const SPECIAL_CMD_CPANEL_PLUGIN_INSTALL = 'cpanelPluginInstall'; /* * @since 1.13.5 * @var string / const SPECIAL_CMD_CPANEL_PLUGIN_UNINSTALL = 'cpanelPluginUninstall'; /* * @var string[] / private $cacheRootCmds = array(); /* * @var string[] / private $commands = array(); /* * @var string / private $svrCacheRootParam = ''; /* * @var string / private $vhCacheRootParam = ''; /* * @var bool / private $displayCacheRoots = false; /* * @var null\|string / private $currWpPath; /* * @var null\|string / private $versionCmd; /* * @var null\|string / private $specialCmd; /* * Holds any additional command input for use after parseCommands(). * * @var null\|array / private $input; /* * * @throws LSCMException Thrown when script argument count is less than * expected. / public function __construct() { if ( empty($_SERVER['argv']) \|\| $_SERVER['argc'] < 3 ) { throw new LSCMException('Cli Illegal entrance!'); } $args = $_SERVER['argv']; /* * shift out script name / array_shift($args); $this->parseCommands($args); } /* * Checks if current $wpInstallStorage object is capable of having the * given non-scan action performed. * * @param string $action * @param WPInstallStorage $wpInstallStorage * * @return void * * @throws LSCMException Thrown when scan data cannot be read. * @throws LSCMException Thrown when expected scan data format has changed. * @throws LSCMException Thrown when attempting to execute a "mass" * operation without any discovered installations. / private function checkDataFile( $action, WPInstallStorage $wpInstallStorage ) { if ( $action == WPInstallStorage::CMD_SCAN2 ) { /* * Always allowed. / return; } if ( ($err = $wpInstallStorage->getError()) ) { switch ($err) { case WPInstallStorage::ERR_NOT_EXIST: case WPInstallStorage::ERR_CORRUPTED: case WPInstallStorage::ERR_VERSION_HIGH: throw new LSCMException( 'Scan data could not be read! Please scan again ' . '(without the \'-n\' flag) before attempting any ' . "cache operations.\n" ); case WPInstallStorage::ERR_VERSION_LOW: throw new LSCMException( 'Scan data file format has been changed for this ' . 'version. Please scan again (without the \'-n\' ' . "flag) before attempting any cache operations.\n" ); //no default } } elseif ( strpos($action,'mass_') === 0 && $wpInstallStorage->getCount() == 0 ) { throw new LSCMException( 'No WordPress installations discovered in the previous scan. ' . 'If you have any newly installed WordPress ' . 'installations, please scan again or add them with ' . "command 'addinstalls'.\n" ); } } /* * * @param WPInstall $wpInstall / private function printStatusMsg( WPInstall $wpInstall ) { $msg = "$this->currWpPath - Status: "; $status = $wpInstall->getStatus(); if ( $status & WPInstall::ST_PLUGIN_ACTIVE ) { $msg .= 'enabled'; if ( !$status & WPInstall::ST_LSC_ADVCACHE_DEFINED ) { $msg .= ', not caching'; } } else { $msg .= 'disabled'; } $msg .= ' \| Flagged: '; $msg .= ($status & WPInstall::ST_FLAGGED) ? 'yes' : 'no'; $msg .= ' \| Error: '; if ( $status & WPInstall::ST_ERR_SITEURL ) { $msg .= 'Could not retrieve WordPress siteURL.'; } elseif ( $status & WPInstall::ST_ERR_DOCROOT ) { $msg .= 'Could not match WordPress siteURL to a known control ' . 'panel docroot.'; } elseif ( $status & WPInstall::ST_ERR_EXECMD ) { $msg .= 'WordPress fatal error encountered during action ' . 'execution. This is most likely caused by custom code in ' . 'this WordPress installation.'; } elseif ( $status & WPInstall::ST_ERR_EXECMD_DB ) { $msg .= 'Error establishing WordPress database connection.'; } elseif ( $status & WPInstall::ST_ERR_TIMEOUT ) { $msg .= 'Timeout occurred during action execution.'; } elseif ( $status & WPInstall::ST_ERR_WPCONFIG ) { $msg .= 'Could not find a valid wp-config.php file.'; } echo "$msg\n\n"; } /* * * @param string[] $args * * @return void * * @throws LSCMException Thrown when -svr parameter is passed without a * value. * @throws LSCMException Thrown when -svr parameter value points to a * non-empty directory. * @throws LSCMException Thrown when -vh parameter is passed without a * value. * @throws LSCMException Thrown when -vh parameter value contains invalid * character '$'. * @throws LSCMException Thrown when -vh parameter value points to a * non-empty directory. * @throws LSCMException Thrown indirectly by * ControlPanel::getClassInstance() call. * @throws LSCMException Thrown indirectly by * $controlPanel->getServerCacheRoot() call. * @throws LSCMException Thrown indirectly by * $controlPanel->getVHCacheRoot() call. / private function handleSetCacheRootInput( array &$args ) { if ( empty($args) ) { $this->cacheRootCmds[] = 'listCacheRoots'; return; } $controlPanel = ControlPanel::getClassInstance(); if ( ($key = array_search('-svr', $args)) !== false ) { if ( empty($args[$key + 1]) \|\| ($this->svrCacheRootParam = trim($args[$key + 1])) == '' ) { throw new LSCMException( 'Invalid Command, missing server cache root value.' ); } $currSvrCacheRoot = $controlPanel->getServerCacheRoot(); if ( $this->svrCacheRootParam != $currSvrCacheRoot ) { if ( !Util::is_dir_empty($this->svrCacheRootParam) ) { throw new LSCMException( 'Provided server level cache root must be an empty ' . 'directory.' ); } $this->cacheRootCmds[] = 'setSvrCacheRoot'; } unset($args[$key], $args[$key + 1]); } if ( ($key = array_search('-vh', $args)) !== false ) { $setvhCacheRoot = false; if ( empty($args[$key + 1]) \|\| ($this->vhCacheRootParam = trim($args[$key + 1])) == '' ) { throw new LSCMException( 'Invalid Command, missing virtual host cache root value.' ); } if ( strpos($this->vhCacheRootParam, '$') !== false ) { throw new LSCMException( 'Invalid Command, virtual host cache root value cannot ' . 'contain any \'$\' characters. \'$vh_user\' will be ' . 'automatically added to the end of virtual host ' . 'cache root values starting with a \'/\'.' ); } $currVHCacheRoot = $controlPanel->getVHCacheRoot(); if ( $this->vhCacheRootParam[0] == '/' ) { $updatedVhCacheRoot = rtrim($this->vhCacheRootParam, '/') . '/$vh_user'; if ( $updatedVhCacheRoot != $currVHCacheRoot && ! Util::is_dir_empty($this->vhCacheRootParam) ) { throw new LSCMException( 'Provided absolute path for virtual host level cache ' . 'root must be an empty directory.' ); } $this->vhCacheRootParam = $updatedVhCacheRoot; $setvhCacheRoot = true; } elseif ( $this->vhCacheRootParam != $currVHCacheRoot ) { $setvhCacheRoot = true; } unset($args[$key], $args[$key + 1]); if ( $setvhCacheRoot ) { $this->cacheRootCmds[] = 'setVHCacheRoot'; } } } /* * * @param string[] $args * * @return void * * @throws LSCMException Thrown when passed version set value is invalid. / private function handleSetVersionInput( array &$args ) { if ( ($key = array_search('--list', $args)) !== false ) { unset($args[$key]); $this->versionCmd = 'list'; return; } if ( ($key = array_search('--latest', $args)) !== false ) { unset($args[$key]); $this->versionCmd = 'latest'; return; } if ( empty($args) ) { $this->versionCmd = 'active'; return; } $v = array_shift($args); if ( preg_match('/[1-9]\.\d(?:\.\d)(?:\.\d)/', $v) !== 1 ) { throw new LSCMException("Invalid version number ($v)."); } $this->versionCmd = $v; } /* * * @param string[] $args / private function handleScanInput( array &$args ) { if ( ($key = array_search('-n', $args)) !== false ) { unset($args[$key]); $this->commands[] = WPInstallStorage::CMD_DISCOVER_NEW2; } else { $this->commands[] = WPInstallStorage::CMD_SCAN2; } if ( ($key = array_search('-e', $args)) !== false ) { unset($args[$key]); $this->commands[] = UserCommand::CMD_MASS_ENABLE; } } /* * * @param string[] $args / private function handleScanNewInput( array &$args ) { if ( ($key = array_search('-en', $args)) !== false ) { unset($args[$key]); $this->commands[] = WPInstallStorage::CMD_DISCOVER_NEW_AND_ENABLE; } else { $this->commands[] = WPInstallStorage::CMD_DISCOVER_NEW2; } } /* * * @param string[] $args * * @return bool / private function isMassOperation( array &$args ) { if ( ($key = array_search('-m', $args)) !== false ) { unset($args[$key]); return true; } return false; } /* * * @param string $cmd * @param string[] $args * * @throws LSCMException Thrown when expected WP path value is not * provided. * @throws LSCMException Thrown when provided an invalid WP path value. / private function handleSingleOperationInput( $cmd, array &$args ) { $path = array_shift($args); if ( $path == null ) { throw new LSCMException('Invalid Command, missing WP path.'); } $wpInstall = new WPInstall($path); if ( !$wpInstall->hasValidPath() ) { throw new LSCMException("Invalid WP Path: $path."); } $this->commands[] = $cmd; $this->currWpPath = rtrim($path, '/'); } /* * * @param string $cmdType * @param string[] $args * * @throws LSCMException Thrown when neither -m nor -wppath parameters are * provided in notify command. * @throws LSCMException Thrown when -wppath parameter is passed without a * value in notify command. * @throws LSCMException Thrown when provided -wppath parameter value is * invalid in notify command. * @throws LSCMException Thrown when -msgfile parameter is passed without a * value in notify command. * @throws LSCMException Thrown when provided -msgfile parameter value * points to a non-existent file in notify command. * @throws LSCMException Thrown when unable to get file contents of the * file pointed to by provided -msgfile value in notify command. * @throws LSCMException Thrown when neither -msgfile nor -msg parameters * are provided in notify command. * @throws LSCMException Thrown when parameter -msg is passed without a * value in notify command. * @throws LSCMException Thrown when expected -plugin parameter is not * provided in notify command. * @throws LSCMException Thrown when provided -plugin parameter value does * not a known plugin slug in notify command. * @throws LSCMException Thrown when neither -m flag nor WP path value are * provided in remove command. * @throws LSCMException Thrown when provided WP path value is invalid in * remove command. / private function handleDashNotifyInput( $cmdType, array &$args ) { if ( $cmdType == 'notify' ) { if ( ($key = array_search('-m', $args)) !== false ) { unset($args[$key]); $this->commands[] = UserCommand::CMD_MASS_DASH_NOTIFY; } else { if ( ($key = array_search('-wppath', $args)) === false ) { throw new LSCMException( 'Invalid Command, missing required \'-m\' or ' . '\'-wppath\' parameter.' ); } if ( empty($args[$key + 1]) ) { throw new LSCMException( 'Invalid Command, missing \'-wppath\' value.' ); } $path = $args[$key + 1]; $wpInstall = new WPInstall($path); if ( !$wpInstall->hasValidPath() ) { throw new LSCMException("Invalid WP Path: $path."); } $this->commands[] = UserCommand::CMD_DASH_NOTIFY; $this->currWpPath = rtrim($path, '/'); unset($args[$key], $args[$key + 1]); } if ( ($key = array_search('-msgfile', $args)) !== false ) { if ( empty($args[$key + 1]) ) { throw new LSCMException( 'Invalid Command, missing \'-msgfile\' value.' ); } $msgFilePath = $args[$key + 1]; if ( !file_exists($msgFilePath) ) { throw new LSCMException( 'Provided message file does not exist.' ); } if ( ($message = file_get_contents($msgFilePath)) === false ) { throw new LSCMException( 'Unable to retrieve provided message file content.' ); } } else { if ( ($key = array_search('-msg', $args)) === false ) { throw new LSCMException( 'Invalid Command, missing required \'-msgfile\' or ' . '\'-msg\' parameter.' ); } if ( empty($args[$key + 1]) ) { throw new LSCMException( 'Invalid Command, missing \'-msg\' value.' ); } $message = $args[$key + 1]; } $dashInput = array( 'msg' => $message ); unset($args[$key], $args[$key + 1]); if ( ($key = array_search('-plugin', $args)) !== false ) { if ( empty($args[$key + 1]) ) { throw new LSCMException( 'Invalid Command, missing \'-plugin\' value.' ); } $slug = $args[$key + 1]; $pluginInfoJSON = Util::get_url_contents( "https://api.wordpress.org/plugins/info/1.0/$slug.json" ); $pluginInfo = json_decode($pluginInfoJSON, true); if ( empty($pluginInfo['name']) ) { throw new LSCMException( 'Could not find a plugin matching the provided plugin ' . 'slug.' ); } $dashInput['slug'] = $slug; unset($args[$key], $args[$key + 1]); } $this->input = $dashInput; } elseif ( $cmdType == 'remove' ) { $arg1 = array_shift($args); if ( $arg1 == '-m' ) { $this->commands[] = UserCommand::CMD_MASS_DASH_DISABLE; } else { $path = $arg1; if ( $path == null ) { throw new LSCMException( 'Invalid Command, missing \'-m\' flag or WP path value.' ); } $wpInstall = new WPInstall($path); if ( !$wpInstall->hasValidPath() ) { throw new LSCMException("Invalid WP Path: $path."); } $this->commands[] = UserCommand::CMD_DASH_DISABLE; $this->currWpPath = rtrim($path, '/'); } } } /* * * @param string[] $args * * @throws LSCMException Thrown when command 'cpanelplugin' is used in a * non-cPanel environment. * @throws LSCMException Thrown indirectly by * ControlPanel::getClassInstance() call. / private function handleCpanelPluginInput( array &$args ) { $controlPanel = ControlPanel::getClassInstance(); if ( !($controlPanel instanceof CPanel) ) { throw new LSCMException( 'Command \'cpanelplugin\' cannot be used in a non-cPanel ' . 'environment.' ); } switch ($args[0]) { case '--install': $this->specialCmd = self::SPECIAL_CMD_CPANEL_PLUGIN_INSTALL; unset($args[0]); break; case '--uninstall': $this->specialCmd = self::SPECIAL_CMD_CPANEL_PLUGIN_UNINSTALL; unset($args[0]); break; case '-autoinstall': if ( !isset($args[1]) ) { $this->specialCmd = self::SPECIAL_CMD_CPANEL_PLUGIN_AUTOINSTALL_STATUS; } elseif ( "$args[1]" === '1' ) { $this->specialCmd = self::SPECIAL_CMD_CPANEL_PLUGIN_AUTOINSTALL_ON; unset($args[1]); } elseif ( "$args[1]" === '0' ) { $this->specialCmd = self::SPECIAL_CMD_CPANEL_PLUGIN_AUTOINSTALL_OFF; unset($args[1]); } unset($args[0]); break; case '--fixconf': $this->specialCmd = self::SPECIAL_CMD_CPANEL_PLUGIN_FIX_CONF; unset($args[0]); break; //no default } } /* * * @param string[] $args * * @throws LSCMException Thrown when -wpinstall parameter is passed without * a value. * @throws LSCMException Thrown when expected 'docroot' value is not * provided when using parameter -wpinstall. * @throws LSCMException Thrown when expected 'server name' value is not * provided when using parameter -wpinstall. * @throws LSCMException Thrown when expected 'site url' value is not * provided when using parameter -wpinstall. * @throws LSCMException Thrown when -wpinstallsfile parameter is passed * without a value. * @throws LSCMException Thrown when provided -wpinstallsfile parameter * value points to a non-existent file. * @throws LSCMException Thrown when unable to get file contents of the * file pointed to by provided -wpinstallsfile parameter value. / private function handleAddInstallsInput( array &$args ) { switch ($args[0]) { case '-wpinstall': if ( empty($args[1]) ) { throw new LSCMException( 'Invalid Command, missing \'<wp path>\' value.' ); } $wpInstallsInfo = "$args[1]"; if ( empty($args[2]) ) { throw new LSCMException( 'Invalid Command, missing \'<docroot>\' value.' ); } $wpInstallsInfo .= " $args[2]"; if ( empty($args[3]) ) { throw new LSCMException( 'Invalid Command, missing \'<server name>\' value.' ); } $wpInstallsInfo .= " $args[3]"; if ( empty($args[4]) ) { throw new LSCMException( 'Invalid Command, missing \'<site url>\' value.' ); } $wpInstallsInfo .= " $args[4]"; $this->commands[] = WPInstallStorage::CMD_ADD_CUST_WPINSTALLS; $this->input = array( 'addInstallsInfo' => array($wpInstallsInfo) ); unset($args[0], $args[1], $args[2], $args[3], $args[4]); break; case '-wpinstallsfile': if ( empty($args[1]) ) { throw new LSCMException( 'Invalid Command, missing \'-wpinstallsfile\' value.' ); } $wpInstallsFile = $args[1]; if ( !file_exists($wpInstallsFile) ) { throw new LSCMException( 'Provided wpinstalls file does not exist.' ); } $fileContent = file_get_contents($wpInstallsFile); if ( $fileContent === false ) { throw new LSCMException( 'Could not read wpinstalls file content.' ); } $this->commands[] = WPInstallStorage::CMD_ADD_CUST_WPINSTALLS; $this->input = array( 'addInstallsInfo' => explode("\n", trim($fileContent)) ); unset($args[0], $args[1]); break; // no default } } /* * * @throws LSCMException Thrown indirectly by * ControlPanel::getClassInstance() call. * @throws LSCMException Thrown indirectly by * $controlPanel->getServerCacheRoot() call. * @throws LSCMException Thrown indirectly by * $controlPanel->getVHCacheRoot() call. / private function displayCacheRoots() { $controlPanel = ControlPanel::getClassInstance(); $svrCacheRoot = $controlPanel->getServerCacheRoot(); $vhCacheRoot = $controlPanel->getVHCacheRoot(); if ( $svrCacheRoot == ControlPanel::NOT_SET ) { $svrCacheRoot = 'Not Set'; } if ( $vhCacheRoot == ControlPanel::NOT_SET) { $vhCacheRoot = 'Not Set'; } echo <<<EOF Server Cache Root: $svrCacheRoot Virtual Host Cache Root: $vhCacheRoot EOF; } /* * * @param string[] $args * * @throws LSCMException Thrown when command setcacheroot is used in the * CustomPanel context. * @throws LSCMException Thrown when an unrecognized command is provided. * @throws LSCMException Thrown when not all provided command arguments are * recognized or used when provided with a valid command. * @throws LSCMException Thrown indirectly by * ControlPanel::getClassInstance() call. * @throws LSCMException Thrown indirectly by * $this->handleSetCacheRootInput() call. * @throws LSCMException Thrown indirectly by * $this->handleSetVersionInput() call. * @throws LSCMException Thrown indirectly by * $this->handleSingleOperationInput() call. * @throws LSCMException Thrown indirectly by * $this->handleDashNotifyInput() call. * @throws LSCMException Thrown indirectly by * $this->handleDashNotifyInput() call. * @throws LSCMException Thrown indirectly by * $this->handleCpanelPluginInput() call. * @throws LSCMException Thrown indirectly by * $this->handleAddInstallsInput() call. / private function parseCommands( array $args ) { $panelClassName = array_shift($args); /* * Initialize ControlPanel instance. / ControlPanel::getClassInstance($panelClassName); $cmd = array_shift($args); switch ( $cmd ) { case 'setcacheroot': if ( $panelClassName == 'custom' ) { throw new LSCMException( 'Command \'setcacheroot\' cannot be used in the ' . 'CustomPanel context.' ); } $this->handleSetCacheRootInput($args); break; case 'setversion': $this->handleSetVersionInput($args); break; case 'scan': $this->handleScanInput($args); break; case 'scannew': $this->handleScanNewInput($args); break; case 'enable': case 'disable': case 'upgrade': /* @noinspection PhpMissingBreakStatementInspection / case 'unflag': if ( $this->isMassOperation($args) ) { $this->commands[] = "mass_$cmd"; break; } //fall through case 'flag': case 'status': $this->handleSingleOperationInput($cmd, $args); break; case 'dashnotify': $this->handleDashNotifyInput('notify', $args); break; case 'dashnotifyremove': $this->handleDashNotifyInput('remove', $args); break; case 'cpanelplugin': $this->handleCpanelPluginInput($args); break; case 'addinstalls': $this->handleAddInstallsInput($args); break; default: throw new LSCMException('Invalid Command, Try --help.'); } if ( !empty($args) ) { throw new LSCMException('Invalid Command, Try --help.'); } } /* * * @param string $action * * @throws LSCMException Thrown indirectly by * ControlPanel::getClassInstance() call. * @throws LSCMException Thrown indirectly by * $controlPanel->setServerCacheRoot() call. * @throws LSCMException Thrown indirectly by * $controlPanel->setVHCacheRoot() call. * @throws LSCMException Thrown indirectly by Util::restartLsws() call. * @throws LSCMException Thrown indirectly by * $controlPanel->getVHCacheRoot() call. / private function doCacheRootCommand( $action ) { $restartRequired = false; $controlPanel = ControlPanel::getClassInstance(); switch ( $action ) { case 'setSvrCacheRoot': $controlPanel->setServerCacheRoot($this->svrCacheRootParam); $restartRequired = true; break; case 'setVHCacheRoot': $controlPanel->setVHCacheRoot($this->vhCacheRootParam); $restartRequired = true; break; case 'listCacheRoots': /* * Wait until after verifyCacheSetup() has been run. / $this->displayCacheRoots = true; break; //no default } if ( $restartRequired ) { Util::restartLsws(); } Util::ensureVHCacheRootInCage($controlPanel->getVHCacheRoot()); } /* * * @throws LSCMException Thrown indirectly by * ControlPanel::getClassInstance() call. * @throws LSCMException Thrown indirectly by * $controlPanel->installCpanelPlugin() call. * @throws LSCMException Thrown indirectly by * CPanel::uninstallCpanelPlugin() call. * @throws LSCMException Thrown indirectly by * $controlPanel->updateCoreCpanelPluginConfSettings() call. / private function doSpecialCommand() { $controlPanel = ControlPanel::getClassInstance(); switch($this->specialCmd) { case self::SPECIAL_CMD_CPANEL_PLUGIN_INSTALL: / @var $controlPanel CPanel / switch ( $controlPanel->installCpanelPlugin() ) { case 'update': echo 'Updated LiteSpeed cPanel plugin to current ' . "version\n\n"; break; case 'new': echo 'LiteSpeed cPanel plugin installed, auto install ' . "turned on.\n\n"; break; //no default } break; case self::SPECIAL_CMD_CPANEL_PLUGIN_UNINSTALL: CPanel::uninstallCpanelPlugin(); echo 'LiteSpeed cPanel plugin uninstalled successfully, auto ' . "install turned off.\n\n"; break; case self::SPECIAL_CMD_CPANEL_PLUGIN_AUTOINSTALL_STATUS: $state = (CPanel::isCpanelPluginAutoInstallOn()) ? 'On' : 'Off'; echo "Auto install is currently $state for the LiteSpeed " . "cPanel plugin.\n"; echo 'Use command \'cpanelplugin -autoinstall {0 \| 1}\' to ' . "turn auto install off/on respectively.\n\n"; break; case self::SPECIAL_CMD_CPANEL_PLUGIN_AUTOINSTALL_ON: if ( CPanel::turnOnCpanelPluginAutoInstall() ) { echo 'Auto install is now On for LiteSpeed cPanel plugin.' . "\n\n"; } else { echo 'Failed to turn off auto install for LiteSpeed cPanel ' . "plugin.\n\n"; } break; case self::SPECIAL_CMD_CPANEL_PLUGIN_AUTOINSTALL_OFF: if ( CPanel::turnOffCpanelPluginAutoInstall() ) { echo 'Auto install is now Off for LiteSpeed cPanel plugin.' . "\n\n"; } else { echo 'Failed to turn on auto install for LiteSpeed cPanel ' . "plugin.\n\n"; } break; case self::SPECIAL_CMD_CPANEL_PLUGIN_FIX_CONF: / @var $controlPanel CPanel / $controlPanel->updateCoreCpanelPluginConfSettings(); echo "Attempted to fix user-end cPanel Plugin conf.\n\n"; break; //no default } } /* * * @throws LSCMException Thrown indirectly by PluginVersion::getInstance() * call. * @throws LSCMException Thrown indirectly by * $pluginVerInstance->getAllowedVersions() call. * @throws LSCMException Thrown indirectly by * $pluginVerInstance->getLatestVersion() call. * @throws LSCMException Thrown indirectly by * $pluginVerInstance->setActiveVersion() call. * @throws LSCMException Thrown indirectly by * $pluginVerInstance->getCurrentVersion() call. * @throws LSCMException Thrown indirectly by * $pluginVerInstance->setActiveVersion() call. / private function doVersionCommand() { $pluginVerInstance = PluginVersion::getInstance(); switch ( $this->versionCmd ) { case 'list': echo "Available versions are: \n" . implode("\n",$pluginVerInstance->getAllowedVersions()) . "\n"; break; case 'latest': $latest = $pluginVerInstance->getLatestVersion(); try { $currVer = $pluginVerInstance->getCurrentVersion(); } catch ( LSCMException $e ) { $currVer = ''; } if ( $latest == $currVer ) { echo "Current version, $latest, is already the latest " . "version.\n"; } else { $pluginVerInstance->setActiveVersion($latest); } break; case 'active': echo "Current active version is " . $pluginVerInstance->getCurrentVersion() . ".\n"; break; default: $pluginVerInstance->setActiveVersion($this->versionCmd); } } /* * * @throws LSCMException Thrown indirectly by Context::getLSCMDataFiles() * call. * @throws LSCMException Thrown indirectly by "new WPInstallStorage()" * call. * @throws LSCMException Thrown indirectly by $this->checkDataFile() call. * @throws LSCMException Thrown indirectly by PluginVersion::getInstance() * call. * @throws LSCMException Thrown indirectly by * $pluginVerInstance->getShortVersions() call. * @throws LSCMException Thrown indirectly by * $pluginVerInstance->getCurrentVersion() call. * @throws LSCMException Thrown indirectly by * DashNotifier::prepLocalDashPluginFiles() call. * @throws LSCMException Thrown indirectly by * ControlPanel::getClassInstance() call. * @throws LSCMException Thrown indirectly by * ControlPanel::getClassInstance()->getDocRoots() call. * @throws LSCMException Thrown indirectly by $wpInstallStorage->scan2() * call. * @throws LSCMException Thrown indirectly by $wpInstallStorage->doAction() * call. / private function doWPInstallStorageAction() { $extraArgs = array(); $list = null; $originalAction = null; $lscmDataFiles = Context::getLSCMDataFiles(); $wpInstallStorage = new WPInstallStorage( $lscmDataFiles['dataFile'], $lscmDataFiles['custDataFile'] ); if ( $this->currWpPath ) { $list = array( $this->currWpPath ); } foreach ( $this->commands as $action ) { $this->checkDataFile($action, $wpInstallStorage); echo "\nPerforming $action operation. Please be patient...\n\n"; switch ( $action ) { case UserCommand::CMD_UPGRADE: case UserCommand::CMD_MASS_UPGRADE: $pluginVerInstance = PluginVersion::getInstance(); $extraArgs[] = implode( ',', $pluginVerInstance->getShortVersions() ); $extraArgs[] = $pluginVerInstance->getCurrentVersion(); break; case UserCommand::CMD_DASH_NOTIFY: case UserCommand::CMD_MASS_DASH_NOTIFY: DashNotifier::prepLocalDashPluginFiles(); $slug = ''; if ( isset($this->input['slug']) ) { $slug = $this->input['slug']; } $msgInfoJSON = json_encode( array( 'msg' => $this->input['msg'], 'plugin' => $slug, 'plugin_name' => '' ) ); $extraArgs[] = base64_encode($msgInfoJSON); break; case WPInstallStorage::CMD_ADD_CUST_WPINSTALLS: $list = array(); $extraArgs[] = $this->input['addInstallsInfo']; break; case WPInstallStorage::CMD_SCAN2: case WPInstallStorage::CMD_DISCOVER_NEW2: case WPInstallStorage::CMD_DISCOVER_NEW_AND_ENABLE: $wpPaths = array(); $docroots = ControlPanel::getClassInstance()->getDocRoots(); foreach ( $docroots as $docroot ) { $wpPaths = array_merge( $wpPaths, WPInstallStorage::scan2($docroot) ); } $list = array(); if ( $action == WPInstallStorage::CMD_DISCOVER_NEW2 \|\| $action == WPInstallStorage::CMD_DISCOVER_NEW_AND_ENABLE ) { foreach( $wpPaths as $wpPath ) { if ( $wpInstallStorage->getWPInstall($wpPath) == null ) { $list[] = $wpPath; } } } else { $list = array_merge($list, $wpPaths); } $originalAction = $action; $action = WPInstallStorage::CMD_ADD_NEW_WPINSTALL; break; // no default case } $wpInstallStorage->doAction($action, $list, $extraArgs); if ( $originalAction == WPInstallStorage::CMD_DISCOVER_NEW_AND_ENABLE ) { $wpInstallStorage->doAction( UserCommand::CMD_MASS_ENABLE, $list ); } if ( $action == UserCommand::CMD_STATUS ) { $wpInstall = $wpInstallStorage->getWPInstall($this->currWpPath); $this->printStatusMsg($wpInstall); } if ( $originalAction != null ) { $action = $originalAction; } echo "\n$action complete!\n\n"; } } /* * * @throws LSCMException Thrown indirectly by $this->doCacheRootCommand() * call. * @throws LSCMException Thrown indirectly by * ControlPanel::getClassInstance() call. * @throws LSCMException Thrown indirectly by * $controlPanel->verifyCacheSetup() call. * @throws LSCMException Thrown indirectly by $this->displayCacheRoots() * call. * @throws LSCMException Thrown indirectly by $this->doSpecialCommand() * call. * @throws LSCMException Thrown indirectly by $this->doVersionCommand() * call. * @throws LSCMException Thrown indirectly by * $this->doWPInstallStorageAction() call. */ private function runCommand() { foreach ( $this->cacheRootCmds as $action ) { $this->doCacheRootCommand($action); } $controlPanel = ControlPanel::getClassInstance(); $controlPanel->verifyCacheSetup(); if ( $this->displayCacheRoots ) { $this->displayCacheRoots(); } if ( $this->specialCmd ) { $this->doSpecialCommand(); } elseif ( $this->versionCmd ) { $this->doVersionCommand(); } else { $this->doWPInstallStorageAction(); } } public static function run() { try { $cli = new self(); $cli->runCommand(); } catch ( Exception $e ) { echo "[ERROR] {$e->getMessage()}\n\n"; exit(1); } } }	40.77 KB	2026-03-12 22:37
📁 Context	-	2026-03-12 22:37
📄 DashNotifier.php <?php / ******************************************* * LiteSpeed Web Server WordPress Dash Notifier * * @author Michael Alegre * @copyright 2019-2023 LiteSpeed Technologies, Inc. * ******************************************* / namespace Lsc\Wp; use Lsc\Wp\Context\Context; use Lsc\Wp\WpWrapper\WpConstants; use Lsc\Wp\WpWrapper\WpFuncs; class DashNotifier { /* * @var string / const BYPASS_FLAG = '.dash_notifier_bypass'; /* * @var string / const DASH_MD5 = 'dash_md5'; /* * @var string / const DASH_PLUGIN = 'dash-notifier/dash-notifier.php'; /* * @var string / const DEFAULT_PLUGIN_PATH = '/wp-content/plugins/dash-notifier'; /* * @deprecated 1.9 * * @var string / const DOWNLOAD_DIR = '/usr/src/litespeed-wp-plugin'; /* * @var string / const PLUGIN_NAME = 'dash-notifier'; /* * @var string / const VER_FILE = 'dash_ver'; private function __construct() { } /* * * @since 1.9 * * @return void * * @throws LSCMException Thrown when read dash version file command fails. * @throws LSCMException Thrown indirectly by self::getLatestVersion() * call. * @throws LSCMException Thrown indirectly by self::downloadVersion() call. * @throws LSCMException Thrown indirectly by self::downloadVersion() call. * @throws LSCMException Thrown indirectly by self::downloadVersion() call. * @throws LSCMException Thrown indirectly by Logger::error() call. / public static function prepLocalDashPluginFiles() { $dashVerFile = Context::LOCAL_PLUGIN_DIR . '/' . self::VER_FILE; if ( ! file_exists($dashVerFile) ) { self::downloadVersion(self::getLatestVersion()); return; } if ( ($content = file_get_contents($dashVerFile)) === false ) { throw new LSCMException( 'prepLocalDashPluginFiles(): Failed to read file ' . self::VER_FILE . ' contents.' ); } $localVer = trim($content); $pluginDir = Context::LOCAL_PLUGIN_DIR . '/' . self::PLUGIN_NAME; if ( ! file_exists($pluginDir) ) { self::downloadVersion($localVer); return; } $isStoredMd5Valid = ( file_get_contents(Context::LOCAL_PLUGIN_DIR . '/' . self::DASH_MD5) == Util::DirectoryMd5($pluginDir) ); if ( !$isStoredMd5Valid ) { self::downloadVersion($localVer); return; } clearstatcache(); if ( (time() - filemtime($dashVerFile)) > 86400 ) { try { $latestVer = self::getLatestVersion(); if ( Util::betterVersionCompare($latestVer, $localVer, '<') ) { self::downloadVersion($latestVer); } } catch ( LSCMException $e ) { Logger::error($e->getMessage()); } touch($dashVerFile); } } /* * * @since 1.9 * * @return string * * @throws LSCMException Thrown when unable to retrieve latest Dash * Notifier plugin version. / public static function getLatestVersion() { $content = Util::get_url_contents( 'https://www.litespeedtech.com/packages/lswpcache/dash_latest' ); if ( empty($content) ) { throw new LSCMException( 'Could not retrieve latest Dash Notifier plugin version' ); } return trim($content); } /* * * @since 1.9 * * @param string $version * * @throws LSCMException Thrown indirectly by self::wgetPlugin() call. / protected static function downloadVersion( $version ) { $pluginDir = Context::LOCAL_PLUGIN_DIR . '/' . self::PLUGIN_NAME; if ( file_exists($pluginDir) ) { exec("/bin/rm -rf $pluginDir"); } self::wgetPlugin($version, true); } /* * * @since 1.9 * * @param string $version * @param bool $saveMD5 * * @throws LSCMException Thrown when wget command fails to download * requested Dash Notifier plugin version. * @throws LSCMException Thrown when unable to unzip downloaded Dash * Notifier plugin package. * @throws LSCMException Thrown when downloaded Dash Notifier plugin * package is missing an expected file. * @throws LSCMException Thrown indirectly by Logger::info() call. * @throws LSCMException Thrown indirectly by Util::unzipFile() call. / protected static function wgetPlugin( $version, $saveMD5 = false ) { Logger::info("Downloading Dash Notifier v$version..."); $zipFileName = self::PLUGIN_NAME . ".$version.zip"; exec( "wget -q --tries=1 --no-check-certificate " . "https://downloads.wordpress.org/plugin/$zipFileName -P " . Context::LOCAL_PLUGIN_DIR, $output, $return_var ); if ( $return_var !== 0 ) { throw new LSCMException( "Failed to download Dash Notifier v$version with wget exit " . "status $return_var.", LSCMException::E_NON_FATAL ); } $localZipFile = Context::LOCAL_PLUGIN_DIR . "/$zipFileName"; $extracted = Util::unzipFile($localZipFile, Context::LOCAL_PLUGIN_DIR); unlink($localZipFile); if ( ! $extracted ) { throw new LSCMException( "Unable to unzip $localZipFile", LSCMException::E_NON_FATAL ); } $pluginDir = Context::LOCAL_PLUGIN_DIR . '/' . self::PLUGIN_NAME; if ( ! file_exists("$pluginDir/" . self::PLUGIN_NAME . '.php') ) { throw new LSCMException( "Unable to download Dash Notifier v$version.", LSCMException::E_NON_FATAL ); } if ( $saveMD5 ) { file_put_contents( Context::LOCAL_PLUGIN_DIR . '/' . self::DASH_MD5, Util::DirectoryMd5($pluginDir) ); } file_put_contents( Context::LOCAL_PLUGIN_DIR . '/' . self::VER_FILE, $version ); } /* * Check if WordPress installation should be notified using the Dash * Notifier plugin. * * @param string $wpPath Root directory for WordPress installation. * * @return bool / public static function canNotify( $wpPath ) { return !file_exists("$wpPath/" . self::BYPASS_FLAG); } /* * Checks the current installation for existing LSCWP plugin files and * copies them to the installation's plugins directory if not found. * This function should only be run as the user. * * @return bool True when new Dash Notifier plugin files are used. * * @throws LSCMException Thrown when unable to copy Dash Notifier plugin * files to WordPress plugin directory. * @throws LSCMException Thrown indirectly by Logger::debug() call. / public static function prepareUserInstall() { $pluginDir = WpConstants::getWpConstant('WP_PLUGIN_DIR'); $dashNotifierPlugin = "$pluginDir/dash-notifier/dash-notifier.php"; if ( file_exists($dashNotifierPlugin) ) { /* * Existing installation detected. / return false; } exec( '/bin/cp -rf ' . Context::LOCAL_PLUGIN_DIR . '/' . self::PLUGIN_NAME . " $pluginDir" ); if ( !file_exists($dashNotifierPlugin) ) { throw new LSCMException( "Failed to copy Dash Notifier plugin files to $pluginDir.", LSCMException::E_NON_FATAL ); } Logger::debug( 'Copied Dash Notifier plugin files into plugins directory ' . $pluginDir ); return true; } /* * Activate Dash Notifier plugin if it is not already activated, and give * the plugin any notification data in the form of a JSON encoded array. * * @param string $jsonInfo Dash Notifier plugin info. * * @return bool * * @throws LSCMException Thrown when unable to find Dash Notifier plugin * files. / public static function doNotify( $jsonInfo ) { if ( file_exists( WpConstants::getWpConstant('WP_PLUGIN_DIR') . '/' . self::DASH_PLUGIN ) ) { /* * Used to pass info to the Dash Notifier Plugin. / Util::define_wrapper( 'DASH_NOTIFIER_MSG', $jsonInfo); if ( !WpFuncs::isPluginActive(self::DASH_PLUGIN) ) { /* * Should not check directly, can error on success due to object * cache. / WpFuncs::activatePlugin(self::DASH_PLUGIN); if ( !WpFuncs::isPluginActive(self::DASH_PLUGIN) ) { return false; } } else { include WpConstants::getWpConstant('WP_PLUGIN_DIR') . '/' . self::DASH_PLUGIN; } } else { throw new LSCMException( 'Dash Notifier plugin files are missing. Cannot notify.', LSCMException::E_NON_FATAL ); } return true; } /* * * @param bool $uninstall */ public static function deactivate( $uninstall ) { WpFuncs::deactivatePlugins(self::DASH_PLUGIN); if ( $uninstall ) { //add some msg about having removed plugin files? WpFuncs::deletePlugins(array( self::DASH_PLUGIN )); } } }	9.89 KB	2026-03-12 22:37
📄 LSCMException.php <?php / **************************************** * LiteSpeed Web Server Cache Manager * @author: LiteSpeed Technologies, Inc. (https://www.litespeedtech.com) * @copyright: (c) 2018 * ******************************************* / namespace Lsc\Wp; class LSCMException extends \Exception { const E_ERROR = 0; /* * show trace msg / const E_PROGRAM = 100; /* * error shown to user / const E_PERMISSION = 101; const E_UNSUPPORTED = 102; /* * Exception is considered non-fatal. Used to determine * UserCommand->runAsUser() return status. */ const E_NON_FATAL = 103; }	651 B	2026-03-12 22:37
📄 LogEntry.php <?php / ******************************************* * LiteSpeed Web Server Cache Manager * * @author LiteSpeed Technologies, Inc. (https://www.litespeedtech.com) * @copyright (c) 2018-2019 * ******************************************* / namespace Lsc\Wp; class LogEntry { /* * @var int / protected $lvl; /* * @var string / protected $msg; /* * * @var null\|string / protected $prefix; /* * * @var int[] / protected $timestamp; /* * * @param string $msg * @param int $lvl / public function __construct( $msg, $lvl ) { $this->msg = $msg; $this->lvl = $lvl; $this->timestamp = time(); } /* * * @param string $msg / public function append( $msg ) { $this->msg .= $msg; } /* * * @return int / public function getLvl() { return $this->lvl; } /* * * @return string / public function getMsg() { $msg = ($this->prefix == null) ? '' : "{$this->prefix} "; if ( $this->msg ) { $msg .= $this->msg; } return $msg; } /* * * @param int $logLvl * @return string * @throws LSCMException Thrown indirectly. */ public function getOutput( $logLvl ) { if ( $this->lvl > $logLvl ) { return ''; } $timestamp = date('Y-m-d H:i:s', $this->timestamp); $addTagInfo = Logger::getAdditionalTagInfo(); $lvl = '[' . Logger::getLvlDescr($this->lvl) . ']'; $msg = $this->getMsg(); return "{$timestamp} {$addTagInfo} {$lvl} {$msg}\n"; } }	1.72 KB	2026-03-12 22:37
📄 Logger.php <?php / ******************************************* * LiteSpeed Web Server Cache Manager * * @author Michael Alegre * @copyright 2018-2023 LiteSpeed Technologies, Inc. * ******************************************* / namespace Lsc\Wp; use Lsc\Wp\Context\ContextOption; /* * Logger is a pseudo singleton. * * Public Logger functions starting with 'p_' are intended for internal use to * account for $instance sometimes being of a different non-extending logger * class. / class Logger { /* * @var int / const L_NONE = 0; /* * @var int / const L_ERROR = 1; /* * @var int / const L_WARN = 2; /* * @var int / const L_NOTICE = 3; /* * @var int / const L_INFO = 4; /* * @var int / const L_VERBOSE = 5; /* * @var int / const L_DEBUG = 9; /* * @var int / const UI_INFO = 0; /* * @var int / const UI_SUCC = 1; /* * @var int / const UI_ERR = 2; /* * @var int / const UI_WARN = 3; /* * @var null\|Logger\|object Object that implements all Logger class public * functions (minus setInstance()). Caution, this requirement is not * enforced in the code. / protected static $instance; /* * @var int Highest log message level allowed to be logged. Set to the * higher value between $this->logFileLvl and $this->logEchoLvl. / protected $logLvl; /* * @var string File that log messages will be written to (if writable). / protected $logFile; /* * @var int Highest log message level allowed to be written to the log * file. / protected $logFileLvl; /* * @var string Additional tag to be added at the start of any log messages. / protected $addTagInfo = ''; /* * @var bool When set to true, log messages will not be written to the log * file until this logger object is destroyed. / protected $bufferedWrite; /* * @var LogEntry[]\|object[] Stores created objects that implement all * LogEntry class public functions. / protected $msgQueue = array(); /* * @var int Highest log message level allowed to echo. / protected $logEchoLvl; /* * @var bool When set to true, echoing of log messages is suppressed. / protected $bufferedEcho; /* * @var string[][] Leveraged by control panel GUI to store and retrieve * display messages. Also used as temporary storage for display only * messages by UserCommand. / protected $uiMsgs = array( self::UI_INFO => array(), self::UI_SUCC => array(), self::UI_ERR => array(), self::UI_WARN => array() ); /* * * @param ContextOption $ctxOption / final protected function __construct( ContextOption $ctxOption ) { $this->logFile = $ctxOption->getDefaultLogFile(); $this->logFileLvl = $ctxOption->getLogFileLvl(); $this->bufferedWrite = $ctxOption->isBufferedWrite(); $this->logEchoLvl = $ctxOption->getLogEchoLvl(); $this->bufferedEcho = $ctxOption->isBufferedEcho(); $this->logLvl = max($this->logEchoLvl, $this->logFileLvl); } /* * * @throws LSCMException Thrown indirectly by $this->writeToFile() call. / public function __destruct() { if ( $this->bufferedWrite ) { $this->writeToFile($this->msgQueue); } } /* * * @param ContextOption $contextOption * * @throws LSCMException Thrown when a static Logger instance has already * been initialized. / public static function Initialize( ContextOption $contextOption ) { if ( static::$instance != null ) { throw new LSCMException( 'Logger cannot be initialized twice.', LSCMException::E_PROGRAM ); } static::$instance = new static($contextOption); } /* * Set static::$instance to a pre-created logger object. * * This function is intended as an alternative to Initialize() and will * throw an exception if static::$instance is already set. * * @since 1.9.1 * * @param object $loggerObj * * @throws LSCMException Thrown when Logger instance is already set. / public static function setInstance( $loggerObj ) { if ( static::$instance != null ) { throw new LSCMException( 'Logger instance already set.', LSCMException::E_PROGRAM ); } static::$instance = $loggerObj; } /* * * @since 1.9 * * @param string $logFile * * @throws LSCMException Thrown indirectly by static::me() call. / public static function changeLogFileUsed( $logFile ) { static::me()->p_setLogFile($logFile); } /* * * @since 1.9 * * @param string $addInfo * * @throws LSCMException Thrown indirectly by static::me() call. / public static function setAdditionalTagInfo( $addInfo ) { static::me()->p_setAddTagInfo($addInfo); } /* * * @since 1.9.1 * * @param string $msg * @param int $type / public function p_addUiMsg( $msg, $type ) { switch ($type) { case static::UI_INFO: case static::UI_SUCC: case static::UI_ERR: case static::UI_WARN: $this->uiMsgs[$type][] = $msg; break; //no default } } /* * * @since 1.9.1 * * @param LogEntry[]\|object[] $entries Array of objects that implement all * LogEntry class public functions. * * @throws LSCMException Thrown indirectly by $this->echoEntries() call. / public function p_echoEntries( array $entries ) { $this->echoEntries($entries); } /* * * @since 1.9.1 * * @return string / public function p_getAddTagInfo() { return $this->addTagInfo; } /* * * @since 1.9.1 * * @return bool / public function p_getBufferedEcho() { return $this->bufferedEcho; } /* * * @since 1.9.1 * * @return bool / public function p_getBufferedWrite() { return $this->bufferedWrite; } /* * * @since 1.9.1 * * @return string / public function p_getLogFile() { return $this->logFile; } /* * * @since 1.9.1 * * @return LogEntry[]\|object[] / public function p_getMsgQueue() { return $this->msgQueue; } /* * * @since 1.9.1 * * @param int $type * * @return string[] / public function p_getUiMsgs( $type ) { switch ($type) { case static::UI_INFO: case static::UI_SUCC: case static::UI_ERR: case static::UI_WARN: return $this->uiMsgs[$type]; default: return array(); } } /* * * @since 1.9.1 * * @param string $msg * @param int $lvl * * @throws LSCMException Thrown indirectly by $this->log() call. / public function p_log( $msg, $lvl ) { $this->log($msg, $lvl); } /* * * @since 1.9.1 * * @param string $addInfo / public function p_setAddTagInfo( $addInfo ) { $this->addTagInfo = $addInfo; } /* * * @since 1.9.1 * * @param string $logFile / public function p_setLogFile( $logFile ) { $this->logFile = $logFile; } /* * * @since 1.9.1 * * @param int $logFileLvl / public function p_setLogFileLvl( $logFileLvl ) { $this->logFileLvl = $logFileLvl; } /* * * @since 1.9.1 * * @param LogEntry[]\|object[] $msgQueue / public function p_setMsgQueue( array $msgQueue ) { $this->msgQueue = $msgQueue; } /* * * @since 1.9.1 * * @param LogEntry[]\|object[] $entries Array of objects that implement all * LogEntry class public functions. * * @throws LSCMException Thrown indirectly by $this->writeToFile() call. / public function p_writeToFile( array $entries ) { $this->writeToFile($entries); } /* * * @since 1.9 * * @return string * * @throws LSCMException Thrown indirectly by static::me() call. / public static function getAdditionalTagInfo() { return static::me()->p_getAddTagInfo(); } /* * * @since 1.9 * * @return string * * @throws LSCMException Thrown indirectly by static::me() call. / public static function getLogFilePath() { return static::me()->p_getLogFile(); } /* * * @since 1.9 * * @return LogEntry[]\|object[] Array of objects that implement all LogEntry * class public functions. * * @throws LSCMException Thrown indirectly by static::me() call. / public static function getLogMsgQueue() { return static::me()->p_getMsgQueue(); } /* * * @param int $type * * @return string[] * * @throws LSCMException Thrown indirectly by static::me() call. / public static function getUiMsgs( $type ) { return static::me()->p_getUiMsgs($type); } /* * Processes any buffered output, writing it to the log file, echoing it * out, or both. * * @throws LSCMException Thrown indirectly by static::me() call. * @throws LSCMException Thrown indirectly by $m->p_writeToFile() call. * @throws LSCMException Thrown indirectly by $m->p_echoEntries() call. / public static function processBuffer() { $clear = false; $m = static::me(); if ( $m->p_getBufferedWrite() ) { $m->p_writeToFile($m->p_getMsgQueue()); $clear = true; } if ( $m->p_getBufferedEcho() ) { $m->p_echoEntries($m->p_getMsgQueue()); $clear = true; } if ( $clear ) { $m->p_setMsgQueue(array()); } } /* * Deprecated 06/25/19. Visibility going to be changed to "protected". * * @deprecated * * @param string $msg * @param int $type * * @throws LSCMException Thrown indirectly by static::me() call. / public static function addUiMsg( $msg, $type ) { static::me()->p_addUiMsg($msg, $type); } /* * Calls addUiMsg() with message level static::UI_INFO. * * @param string $msg * * @throws LSCMException Thrown indirectly by static::addUiMsg() call. / public static function uiInfo( $msg ) { static::addUiMsg($msg, static::UI_INFO); } /* * Calls addUiMsg() with message level static::UI_SUCC. * * @param string $msg * * @throws LSCMException Thrown indirectly by static::addUiMsg() call. / public static function uiSuccess( $msg ) { static::addUiMsg($msg, static::UI_SUCC); } /* * Calls addUiMsg() with message level static::UI_ERR. * * @param string $msg * * @throws LSCMException Thrown indirectly by static::addUiMsg() call. / public static function uiError( $msg ) { static::addUiMsg($msg, static::UI_ERR); } /* * Calls addUiMsg() with message level static::UI_WARN. * * @param string $msg * * @throws LSCMException Thrown indirectly by static::addUiMsg() call. / public static function uiWarning( $msg ) { static::addUiMsg($msg, static::UI_WARN); } /* * * @param string $msg * @param int $lvl * * @throws LSCMException Thrown indirectly by static::me() call. * @throws LSCMException Thrown indirectly by static::me()->p_log() call. / public static function logMsg( $msg, $lvl ) { static::me()->p_log($msg, $lvl); } /* * Calls logMsg() with message level static::L_ERROR. * * @param string $msg * * @throws LSCMException Thrown indirectly by static::logMsg() call. / public static function error( $msg ) { static::logMsg($msg, static::L_ERROR); } /* * Calls logMsg() with message level static::L_WARN. * * @param string $msg * * @throws LSCMException Thrown indirectly by static::logMsg() call. / public static function warn( $msg ) { static::logMsg($msg, static::L_WARN); } /* * Calls logMsg() with message level static::L_NOTICE. * * @param string $msg * * @throws LSCMException Thrown indirectly by static::logMsg() call. / public static function notice( $msg ) { static::logMsg($msg, static::L_NOTICE); } /* * Calls logMsg() with message level static::L_INFO. * * @param string $msg * * @throws LSCMException Thrown indirectly by static::logMsg() call. / public static function info( $msg ) { static::logMsg($msg, static::L_INFO); } /* * Calls logMsg() with message level static::L_VERBOSE. * * @param string $msg * * @throws LSCMException Thrown indirectly by static::logMsg() call. / public static function verbose( $msg ) { static::logMsg($msg, static::L_VERBOSE); } /* * Calls logMsg() with message level static::L_DEBUG. * * @param string $msg * * @throws LSCMException Thrown indirectly by static::logMsg() call. / public static function debug( $msg ) { static::logMsg($msg, static::L_DEBUG); } /* * * @return Logger\|object Object that implements all Logger class public * functions. * * @throws LSCMException Thrown when Logger instance has not yet been * initialized. / protected static function me() { if ( static::$instance == null ) { throw new LSCMException( 'Logger Uninitialized.', LSCMException::E_PROGRAM ); } return static::$instance; } /* * * @param string $msg * @param int $lvl * * @throws LSCMException Thrown indirectly by $this->writeToFile() call. * @throws LSCMException Thrown indirectly by $this->echoEntries() call. / protected function log( $msg, $lvl ) { $entry = new LogEntry($msg, $lvl); $this->msgQueue[] = $entry; if ( !$this->bufferedWrite ) { $this->writeToFile(array( $entry )); } if ( !$this->bufferedEcho ) { $this->echoEntries(array( $entry )); } } /* * * @param LogEntry[]\|object[] $entries Array of objects that implements all * LogEntry class public functions. * * @throws LSCMException Thrown indirectly by $e->getOutput() call. / protected function writeToFile( array $entries ) { $content = ''; foreach ( $entries as $e ) { $content .= $e->getOutput($this->logFileLvl); } if ( $content != '' ) { if ( $this->logFile ) { file_put_contents( $this->logFile, $content, FILE_APPEND \| LOCK_EX ); } else { error_log($content); } } } /* * * @param LogEntry[]\|object[] $entries Array of objects that implement all * LogEntry class public functions. * * @throws LSCMException Thrown indirectly by $entry->getOutput() call. / protected function echoEntries( array $entries ) { foreach ( $entries as $entry ) { if ( ($msg = $entry->getOutput($this->logEchoLvl)) !== '' ) { echo $msg; } } } /* * * @param int $lvl * * @return string / public static function getLvlDescr( $lvl ) { switch ($lvl) { case static::L_ERROR: return 'ERROR'; case static::L_WARN: return 'WARN'; case static::L_NOTICE: return 'NOTICE'; case static::L_INFO: return 'INFO'; case static::L_VERBOSE: return 'DETAIL'; case static::L_DEBUG: return 'DEBUG'; default: /* * Do silently. / return ''; } } /* * Not used yet. Added for later cases where shared log level should be * changed to match panel log level. * * @deprecated 1.9.1 Deprecated on 11/22/19. Function is likely not needed * after recent logger changes. * * @param int $lvl * * @return bool * * @throws LSCMException Thrown indirectly by static::me() call. / public static function setLogFileLvl( $lvl ) { $lvl = (int)$lvl; if ( static::isValidLogFileLvl($lvl) ) { if ( $lvl > static::L_DEBUG ) { $lvl = static::L_DEBUG; } static::me()->p_setLogFileLvl($lvl); return true; } return false; } /* * * @param int $lvl * * @return bool / protected static function isValidLogFileLvl( $lvl ) { if ( is_int($lvl) && $lvl >= 0 ) { return true; } return false; } /* * Prevent cloning here and in extending classes. */ final protected function __clone() {} }	17.95 KB	2026-03-12 22:37
📁 Panel	-	2026-03-12 22:37
📄 PanelController.php <?php / ******************************************* * LiteSpeed Web Server Cache Manager * * @author Michael Alegre * @copyright 2018-2026 LiteSpeed Technologies, Inc. * ******************************************* / namespace Lsc\Wp; use Lsc\Wp\Context\Context; use Lsc\Wp\Panel\ControlPanel; use Lsc\Wp\View\AjaxView; use Lsc\Wp\View\Model\Ajax as AjaxViewModel; class PanelController { /* * @var int / const MGR_STEP_NONE = 0; /* * @var int / const MGR_STEP_SCAN = 1; /* * @var int / const MGR_STEP_DISCOVER_NEW = 2; /* * @var int / const MGR_STEP_REFRESH_STATUS = 3; /* * @var int / const MGR_STEP_MASS_UNFLAG = 4; /* * @var int / const MGR_STEP_MASS_FLAG = 5; /* * @var int / const DASH_STEP_NONE = 0; /* * @var int / const DASH_STEP_MASS_DASH_NOTIFY = 1; /* * @var int / const DASH_STEP_MASS_DASH_DISABLE = 2; /* * @var ControlPanel / protected $panelEnv; /* * @var WPInstallStorage / protected $wpInstallStorage; /* * @var int / protected $mgrStep; /* * @var int / protected $dashStep = self::DASH_STEP_NONE; /* * * @param ControlPanel $panelEnv * @param WPInstallStorage $wpInstallStorage * @param int $mgrStep / public function __construct( ControlPanel $panelEnv, WPInstallStorage $wpInstallStorage, $mgrStep = self::MGR_STEP_NONE ) { $this->panelEnv = $panelEnv; $this->wpInstallStorage = $wpInstallStorage; $this->mgrStep = $mgrStep; } /* * * @param string $type * * @return void\|string[] / protected function getCurrentAction( $type = 'cacheMgr' ) { switch ( $type ) { case 'dashNotifier': $all_actions = [ 'notify_single' => UserCommand::CMD_DASH_NOTIFY, 'disable_single' => UserCommand::CMD_DASH_DISABLE, 'get_msg' => WPDashMsgs::ACTION_GET_MSG, 'add_msg' => WPDashMsgs::ACTION_ADD_MSG, 'delete_msg' => WPDashMsgs::ACTION_DELETE_MSG ]; break; case 'cacheMgr': $all_actions = [ 'enable_single' => UserCommand::CMD_ENABLE, 'disable_single' => UserCommand::CMD_DISABLE, 'flag_single' => WPInstallStorage::CMD_FLAG, 'unflag_single' => WPInstallStorage::CMD_UNFLAG, 'refresh_status_single' => UserCommand::CMD_STATUS, 'enable_sel' => UserCommand::CMD_ENABLE, 'disable_sel' => UserCommand::CMD_DISABLE, 'flag_sel' => WPInstallStorage::CMD_FLAG, 'unflag_sel' => WPInstallStorage::CMD_UNFLAG ]; break; default: return; } foreach ( $all_actions as $act => $doAct ) { if ( Util::get_request_var($act) !== null ) { return [ 'act_key' => $act, 'action' => $doAct ]; } } } /* * * @deprecated * * @return int * * @throws LSCMException Thrown indirectly by * $this->manageCacheOperations() call. / public function manageOperationsSubController() { return $this->manageCacheOperations(); } /* * * @deprecated 1.13.3 Use $this->manageCacheOperations2() instead. * * @return int * * @throws LSCMException Thrown indirectly by $this->checkScanAction() * call. * @throws LSCMException Thrown indirectly by $this->checkRefreshAction() * call. * @throws LSCMException Thrown indirectly by $this->checkUnflagAction() * call. * @throws LSCMException Thrown indirectly by $this->doFormAction() call. * @throws LSCMException Thrown indirectly by $this->doSingleAction() call. / public function manageCacheOperations() { if ( $this->checkScanAction() \|\| $this->checkRefreshAction() \|\| $this->checkFlagActions() \|\| ($actionInfo = $this->getCurrentAction()) == NULL ) { return $this->mgrStep; } $actKey = $actionInfo['act_key']; $action = $actionInfo['action']; if ( strcmp(substr($actKey, -3), 'sel') == 0 ) { $this->doFormAction($action); } else { $this->doSingleAction($action, Util::get_request_var($actKey)); } return $this->mgrStep; } /* * * @since 1.13.3 * * @return int * * @throws LSCMException Thrown indirectly by $this->checkScanAction2() * call. * @throws LSCMException Thrown indirectly by $this->checkRefreshAction() * call. * @throws LSCMException Thrown indirectly by $this->checkUnflagAction() * call. * @throws LSCMException Thrown indirectly by $this->doFormAction() call. * @throws LSCMException Thrown indirectly by $this->doSingleAction() call. / public function manageCacheOperations2() { if ( $this->checkScanAction2() \|\| $this->checkRefreshAction() \|\| $this->checkFlagActions() \|\| ($actionInfo = $this->getCurrentAction()) == NULL ) { return $this->mgrStep; } $actKey = $actionInfo['act_key']; $action = $actionInfo['action']; if ( strcmp(substr($actKey, -3), 'sel') == 0 ) { $this->doFormAction($action); } else { $path = Util::get_request_var($actKey); $this->doSingleAction($action, $path); } return $this->mgrStep; } /* * * @return string / protected function getDashMsgInfoJSON() { $msgInfo = [ 'msg' => '', 'plugin' => '', 'plugin_name' => '' ]; if ( ($msg = Util::get_request_var('notify_msg')) !== NULL ) { $msgInfo['msg'] = trim($msg); } if ( ($slug = Util::get_request_var('notify_slug')) !== NULL ) { $msgInfo['plugin'] = trim($slug); } /* * plugin_name is not passed at this time. / return json_encode($msgInfo); } /* * * @param int $dashStep * @param WPDashMsgs $wpDashMsgs * * @return int * * @throws LSCMException Thrown indirectly by * $this->checkDashMassNotifyAction() call. * @throws LSCMException Thrown indirectly by * $this->checkDashMassDisableAction() call. * @throws LSCMException Thrown indirectly by $this->doWpDashMsgOperation() * call. * @throws LSCMException Thrown indirectly by $this->doSingleDashAction() * call. / public function manageDashOperations( $dashStep, WPDashMsgs $wpDashMsgs ) { $this->dashStep = $dashStep; if ( $this->checkDashMassNotifyAction() \|\| $this->checkDashMassDisableAction() \|\| ($actionInfo = $this->getCurrentAction('dashNotifier')) == NULL ) { return $this->dashStep; } $actKey = $actionInfo['act_key']; $action = $actionInfo['action']; $msgInfoJSON = ''; if ( substr($action, 0, 3) == 'msg' ) { $this->doWpDashMsgOperation($wpDashMsgs, $action); } if ( $actKey == UserCommand::CMD_DASH_NOTIFY ) { $msgInfoJSON = base64_encode($this->getDashMsgInfoJSON()); } $this->doSingleDashAction( $action, Util::get_request_var($actKey), $msgInfoJSON ); return $this->dashStep; } /* * * @param array $array * * @return int * * @throws LSCMException Rethrown when Context::getOption() throws an * LSCMException exception. * @throws LSCMException Thrown indirectly by Logger::error() call. / protected function getBatchSize( array $array ) { try { $batchSize = Context::getOption()->getBatchSize(); } catch ( LSCMException $e ) { $msg = "{$e->getMessage()} Could not get batch size."; Logger::error($msg); throw new LSCMException($msg); } if ( $batchSize > ($arrSize = count($array)) ) { return $arrSize; } return $batchSize; } /* * * @param object $viewModel * @param string $tplID * * @return string * * @throws LSCMException Thrown indirectly by Logger::error() call. / protected function getAjaxViewContent( $viewModel, $tplID = '' ) { try { return (new AjaxView($viewModel))->getAjaxContent($tplID); } catch ( LSCMException $e ) { Logger::error($e->getMessage()); } return ''; } /* * * @deprecated 1.9 Moved to using AjaxResponse object for this. * * @param array $ajaxInfo / protected function ajaxReturn( array $ajaxInfo ) { ob_clean(); echo json_encode($ajaxInfo); exit; } /* * * @deprecated 1.13.3 Use $this->checkScanAction2() instead. * * @return bool\|void Function outputs ajax and exits without returning a * value when $init is evaluated to be false. * * @throws LSCMException Thrown indirectly by * $this->panelEnv->getDocroots() call. * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by $this->getBatchSize() call. * @throws LSCMException Thrown indirectly by * $this->wpInstallStorage->doAction() call. * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. * @throws LSCMException Thrown indirectly by AjaxResponse::outputAndExit() * call. / protected function checkScanAction() { $init = false; $action = ''; if ( $this->mgrStep == self::MGR_STEP_SCAN ) { $action = WPInstallStorage::CMD_SCAN; } elseif ( $this->mgrStep == self::MGR_STEP_DISCOVER_NEW ) { $action = WPInstallStorage::CMD_DISCOVER_NEW; } elseif ( Util::get_request_var('re-scan') ) { $this->mgrStep = self::MGR_STEP_SCAN; $init = true; } elseif ( Util::get_request_var('scan_more') ) { $this->mgrStep = self::MGR_STEP_DISCOVER_NEW; $init = true; } else { return false; } if ( session_status() !== PHP_SESSION_ACTIVE ) { session_start(); } $info = &$_SESSION['scanInfo']; if ( $init ) { $info = [ 'homeDirs' => $this->panelEnv->getDocroots() ]; return true; } $completedCount = -1; if ( !isset($info['homeDirs']) ) { Logger::uiError( 'Expected session data missing! Stopping mass operation.' ); } else { $batchSize = $this->getBatchSize($info['homeDirs']); $batch = array_splice($info['homeDirs'], 0, $batchSize); $completedCount = count( $this->wpInstallStorage->doAction( $action, $batch ) ); if ( $completedCount != $batchSize ) { $info['homeDirs'] = array_merge( array_slice($batch, $completedCount), $info['homeDirs'] ); } } if ( empty($info['homeDirs']) ) { unset($_SESSION['scanInfo']); } $msgs = $this->wpInstallStorage->getAllCmdMsgs(); AjaxResponse::setAjaxContent( json_encode( [ 'completed' => $completedCount, 'errMsgs' => array_merge( $msgs['fail'], $msgs['err'], Logger::getUiMsgs(Logger::UI_ERR) ) ] ) ); AjaxResponse::outputAndExit(); } /* * * @since 1.15 * * @param string[] $docroots * @param string[] $wpPaths Array of discovered WordPress installations * (passed by address). * * @return int Completed count. * * @throws LSCMException Thrown indirectly by WPInstallStorage->scan2() * call. / protected function runScan2Logic( array $docroots, array &$wpPaths ) { foreach ( $docroots as $docroot ) { $wpPaths = array_merge( $wpPaths, WPInstallStorage::scan2($docroot) ); } return count($docroots); } /* * * @since 1.13.3 * * @return bool\|void Function outputs ajax and exits without returning a * value when $init is evaluated to be false. * * @throws LSCMException Thrown indirectly by * $this->panelEnv->getDocroots() call. * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by $this->getBatchSize() call. * @throws LSCMException Thrown indirectly by $this->runScan2Logic() call. * @throws LSCMException Thrown indirectly by $this->getBatchSize() call. * @throws LSCMException Thrown indirectly by * $this->wpInstallStorage->doAction() call. * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. * @throws LSCMException Thrown indirectly by AjaxResponse::outputAndExit() * call. / protected function checkScanAction2() { $init = false; $action = ''; if ( $this->mgrStep == self::MGR_STEP_SCAN ) { $action = WPInstallStorage::CMD_SCAN2; } elseif ( $this->mgrStep == self::MGR_STEP_DISCOVER_NEW ) { $action = WPInstallStorage::CMD_DISCOVER_NEW2; } elseif ( Util::get_request_var('re-scan') ) { $this->mgrStep = self::MGR_STEP_SCAN; $init = true; } elseif ( Util::get_request_var('scan_more') ) { $this->mgrStep = self::MGR_STEP_DISCOVER_NEW; $init = true; } else { return false; } if ( session_status() !== PHP_SESSION_ACTIVE ) { session_start(); } if ( Util::get_request_var('go_to_next') == 1 ){ return true; } $info = &$_SESSION['scanInfo']; if ( $init ) { $info = [ 'homeDirs' => $this->panelEnv->getDocroots(), 'installs' => [] ]; return true; } $scanStep = self::MGR_STEP_NONE; $errMsgs = []; $completedCount = -1; if ( !is_array($info) \|\| !array_key_exists('homeDirs', $info) \|\| !array_key_exists('installs', $info) ) { Logger::uiError( 'Expected session data missing! Stopping mass operation.' ); } else { if ( $info['homeDirs'] !== null ) { $scanStep = self::MGR_STEP_SCAN; $batchSize = $this->getBatchSize($info['homeDirs']); $batch = array_splice($info['homeDirs'], 0, $batchSize); $wpPaths = []; $completedCount = $this->runScan2Logic($batch, $wpPaths); if ( $completedCount != $batchSize ) { $info['homeDirs'] = array_merge( array_slice($batch, $completedCount), $info['homeDirs'] ); } if ( $action == WPInstallStorage::CMD_DISCOVER_NEW2 ) { foreach( $wpPaths as $wpPath ) { if ( $this->wpInstallStorage->getWPInstall($wpPath) == null) { $info['installs'][] = $wpPath; } } } else { $info['installs'] = array_merge($info['installs'], $wpPaths); } if ( empty($info['homeDirs']) ) { $info['homeDirs'] = null; if ( $action == WPInstallStorage::CMD_SCAN2 ) { $flippedInstalls = array_flip($info['installs']); $wpInstalls = $this->wpInstallStorage->getWPInstalls(); if ( $wpInstalls === null ) { $wpInstalls = []; } foreach ( $wpInstalls as $wpInstall ) { $wpInstallPath = $wpInstall->getPath(); if ( !isset($flippedInstalls[$wpInstallPath]) ) { $info['installs'][] = $wpInstallPath; } } } } } elseif ( $info['installs'] !== null ) { $scanStep = self::MGR_STEP_DISCOVER_NEW; $batchSize = $this->getBatchSize($info['installs']); $batch = array_splice($info['installs'], 0, $batchSize); $completedCount = count( $this->wpInstallStorage->doAction( WPInstallStorage::CMD_ADD_NEW_WPINSTALL, $batch ) ); if ( $completedCount != $batchSize ) { $info['installs'] = array_merge( array_slice($batch, $completedCount), $info['installs'] ); } $msgs = $this->wpInstallStorage->getAllCmdMsgs(); $errMsgs = array_merge($msgs['fail'], $msgs['err']); if ( empty($info['installs']) ) { $info['installs'] = null; } } } if ( $info['homeDirs'] === null && $info['installs'] === null ) { unset($_SESSION['scanInfo']); } AjaxResponse::setAjaxContent( json_encode( [ 'scanStep' => $scanStep, 'completed' => $completedCount, 'errMsgs' => array_merge( $errMsgs, Logger::getUiMsgs(Logger::UI_ERR) ) ] ) ); AjaxResponse::outputAndExit(); } /* * * @return bool\|void Function outputs ajax and exits without returning a * value when $init is evaluated to be false. * * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by $this->getBatchSize() call. * @throws LSCMException Thrown indirectly by * $this->wpInstallStorage->doAction() call. * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. * @throws LSCMException Thrown indirectly by AjaxResponse::outputAndExit() * call. / protected function checkRefreshAction() { if ( $this->mgrStep == self::MGR_STEP_REFRESH_STATUS ) { $init = false; } elseif ( Util::get_request_var('refresh_status') ) { $init = true; $this->mgrStep = self::MGR_STEP_REFRESH_STATUS; } else { return false; } if ( session_status() !== PHP_SESSION_ACTIVE ) { session_start(); } $info = &$_SESSION['refreshInfo']; if ( $init ) { $info = [ 'installs' => $this->wpInstallStorage->getPaths() ]; return true; } $completedCount = -1; if ( !isset($info['installs']) ) { Logger::uiError( 'Expected session data missing! Stopping mass operation.' ); } else { $batchSize = $this->getBatchSize($info['installs']); $batch = array_splice($info['installs'], 0, $batchSize); $completedCount = count( $this->wpInstallStorage->doAction( UserCommand::CMD_STATUS, $batch ) ); if ( $completedCount != $batchSize ) { $info['installs'] = array_merge( array_slice($batch, $completedCount), $info['installs'] ); } } if ( empty($info['installs']) ) { unset($_SESSION['refreshInfo']); } $msgs = $this->wpInstallStorage->getAllCmdMsgs(); AjaxResponse::setAjaxContent( json_encode( [ 'completed' => $completedCount, 'errMsgs' => array_merge( $msgs['fail'], $msgs['err'], Logger::getUiMsgs(Logger::UI_ERR) ) ] ) ); AjaxResponse::outputAndExit(); } /* * * @return bool\|void Function outputs ajax and exits without returning a * value when $init is evaluated to be false. * * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by $this->getBatchSize() call. * @throws LSCMException Thrown indirectly by * $this->wpInstallStorage->doAction() call. * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. * @throws LSCMException Thrown indirectly by AjaxResponse::outputAndExit() * call. / protected function checkUnflagAction() { if ( $this->mgrStep == self::MGR_STEP_MASS_UNFLAG ) { $init = false; } elseif ( Util::get_request_var('mass_unflag') ) { $init = true; $this->mgrStep = self::MGR_STEP_MASS_UNFLAG; } else { return false; } if ( session_status() !== PHP_SESSION_ACTIVE ) { session_start(); } $info = &$_SESSION['unflagInfo']; if ( $init ) { $info = [ 'installs' => $this->wpInstallStorage->getPaths() ]; return true; } $completedCount = -1; if ( !isset($info['installs']) ) { Logger::uiError( 'Expected session data missing! Stopping mass operation.' ); } else { $batchSize = $this->getBatchSize($info['installs']); $batch = array_splice($info['installs'], 0, $batchSize); $completedCount = count( $this->wpInstallStorage->doAction( WPInstallStorage::CMD_MASS_UNFLAG, $batch ) ); if ( $completedCount != $batchSize ) { $info['installs'] = array_merge( array_slice($batch, $completedCount), $info['installs'] ); } } if ( empty($info['installs']) ) { unset($_SESSION['unflagInfo']); } $msgs = $this->wpInstallStorage->getAllCmdMsgs(); AjaxResponse::setAjaxContent( json_encode( [ 'completed' => $completedCount, 'errMsgs' => array_merge( $msgs['fail'], $msgs['err'], Logger::getUiMsgs(Logger::UI_ERR) ), 'succMsgs' => array_merge( $msgs['succ'], Logger::getUiMsgs(Logger::UI_SUCC) ) ] ) ); AjaxResponse::outputAndExit(); } /* * * @return bool\|void Function outputs ajax and exits without returning a * value when $init is evaluated to be false. * * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by $this->getBatchSize() call. * @throws LSCMException Thrown indirectly by * $this->wpInstallStorage->doAction() call. * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. * @throws LSCMException Thrown indirectly by AjaxResponse::outputAndExit() * call. / protected function checkFlagActions() { if ( $this->mgrStep == self::MGR_STEP_MASS_UNFLAG ) { $action = WPInstallStorage::CMD_MASS_UNFLAG; $init = false; } elseif ( $this->mgrStep == self::MGR_STEP_MASS_FLAG ) { $action = WPInstallStorage::CMD_MASS_FLAG; $init = false; } elseif ( Util::get_request_var('mass_unflag') ) { $action = WPInstallStorage::CMD_MASS_UNFLAG; $init = true; $this->mgrStep = self::MGR_STEP_MASS_UNFLAG; } elseif ( Util::get_request_var('mass_flag') ) { $action = WPInstallStorage::CMD_MASS_FLAG; $init = true; $this->mgrStep = self::MGR_STEP_MASS_FLAG; } else { return false; } if ( session_status() !== PHP_SESSION_ACTIVE ) { session_start(); } $info = &$_SESSION["{$action}_info"]; $doOld = false; if ( $action == WPInstallStorage::CMD_MASS_UNFLAG ) { /* * Set to maintain compatibility with old ViewModel + Tpl. * * @deprecated 1.17.4.2 / $oldInfo = &$_SESSION['unflagInfo']; $doOld = true; } if ( $init ) { $info = [ 'installs' => $this->wpInstallStorage->getPaths() ]; if ( $doOld ) { $oldInfo = $info; } return true; } $completedCount = -1; if ( !isset($info['installs']) ) { Logger::uiError( 'Expected session data missing! Stopping mass operation.' ); } else { $batchSize = $this->getBatchSize($info['installs']); $batch = array_splice($info['installs'], 0, $batchSize); $completedCount = count( $this->wpInstallStorage->doAction($action, $batch) ); if ( $completedCount != $batchSize ) { $info['installs'] = array_merge( array_slice($batch, $completedCount), $info['installs'] ); } } if ( empty($info['installs']) ) { unset($_SESSION["{$action}_info"]); if ( $doOld ) { unset($_SESSION['unflagInfo']); } } elseif ( $doOld ) { $oldInfo = $info; } $msgs = $this->wpInstallStorage->getAllCmdMsgs(); AjaxResponse::setAjaxContent( json_encode( [ 'completed' => $completedCount, 'errMsgs' => array_merge( $msgs['fail'], $msgs['err'], Logger::getUiMsgs(Logger::UI_ERR) ), 'succMsgs' => array_merge( $msgs['succ'], Logger::getUiMsgs(Logger::UI_SUCC) ) ] ) ); AjaxResponse::outputAndExit(); } /* * * @param string $action * * @return void * * @throws LSCMException Rethrown when Context::getOption() throws an * LSCMException exception. * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by Logger::error() call. * @throws LSCMException Thrown indirectly by * $this->wpInstallStorage->doAction() call. / protected function doFormAction( $action ) { $list = Util::get_request_list('installations'); /* * Empty list also checked earlier using JS. / if ( $list == NULL ) { Logger::uiError('Please select at least one checkbox.'); return; } foreach ( $list as $wpPath ) { if ( $this->wpInstallStorage->getWPInstall($wpPath) === null ) { Logger::uiError( 'Invalid input value detected - No Action Taken' ); return; } } try { Context::getOption()->setBatchTimeout(0); } catch ( LSCMException $e ) { $msg = "{$e->getMessage()} Could not set batch timeout."; Logger::error($msg); throw new LSCMException($msg); } $this->wpInstallStorage->doAction($action, $list); } /* * Get simple string representations of current installation status. * * @param WPInstall $wpInstall * * @return string[] / protected function getStatusStrings( WPInstall $wpInstall ) { $status = $wpInstall->getStatus(); if ( $status & WPInstall::ST_ERR_REMOVE ) { $statusString = 'removed'; } elseif ( $wpInstall->hasFatalError() ) { $statusString = 'error'; } elseif ( ($status & WPInstall::ST_PLUGIN_INACTIVE ) ) { $statusString = 'disabled'; } elseif ( !($status & WPInstall::ST_LSC_ADVCACHE_DEFINED) ) { $statusString = 'warning'; } else { $statusString = 'enabled'; } if ( $wpInstall->isFlagBitSet() ) { $flagString = 'flagged'; } else { $flagString = 'unflagged'; } return [ 'status' => $statusString, 'flag_status' => $flagString ]; } /* * * @param string $action * @param string $path * * @return void * * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by * $this->wpInstallStorage->doAction() call. * @throws LSCMException Thrown indirectly by $this->getAjaxViewContent() * call. * @throws LSCMException Thrown indirectly by $this->getAjaxViewContent() * call. * @throws LSCMException Thrown indirectly by $this->getAjaxViewContent() * call. * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. * @throws LSCMException Thrown indirectly by AjaxResponse::outputAndExit() * call. / protected function doSingleAction( $action, $path ) { $wpInstall = $this->wpInstallStorage->getWPInstall($path); if ( $wpInstall === null ) { Logger::uiError('Invalid input value detected - No Action Taken'); return; } $preStatusInfo = $this->getStatusStrings($wpInstall); $this->wpInstallStorage->doAction($action, [ $path ]); $postStatusInfo = $this->getStatusStrings($wpInstall); $badgesDown = $badgesUp = []; $removed = false; if ( $postStatusInfo['status'] == 'removed' ) { $removed = true; $badgesDown[] = $preStatusInfo['status']; $badgesDown[] = 'flag'; } else { if ( $preStatusInfo['status'] != $postStatusInfo['status'] ) { $badgesDown[] = $preStatusInfo['status']; $badgesUp[] = $postStatusInfo['status']; } if ( $preStatusInfo['flag_status'] != $postStatusInfo['flag_status'] ) { if ( $postStatusInfo['flag_status'] == 'flagged' ) { $badgesUp[] = 'flag'; } else { $badgesDown[] = 'flag'; } } } $viewModel = new AjaxViewModel\CacheMgrRowViewModel($wpInstall); $statusSort = $viewModel->getsortVal('status'); $flagSort = $viewModel->getsortVal('flag'); switch ( $flagSort ) { case 'removed': $flagSearch = $flagSort; break; case 'flagged': $flagSearch = 'f'; break; default: $flagSearch = 'u'; } $msgs = $this->wpInstallStorage->getAllCmdMsgs(); AjaxResponse::setAjaxContent( json_encode( [ 'displayData' => [ 'actions_td' => $this->getAjaxViewContent($viewModel, 'actions_td'), 'status_search' => $statusSort, 'status_sort' => $statusSort, 'status_td' => $this->getAjaxViewContent($viewModel, 'status_td'), 'flag_search' => $flagSearch, 'flag_sort' => $flagSort, 'flag_td' => $this->getAjaxViewContent($viewModel, 'flag_td') ], 'badgesDown' => $badgesDown, 'badgesUp' => $badgesUp, 'removed' => $removed, 'errMsgs' => array_merge( $msgs['fail'], $msgs['err'], Logger::getUiMsgs(Logger::UI_ERR) ), 'succMsgs' => array_merge( $msgs['succ'], Logger::getUiMsgs(Logger::UI_SUCC) ) ] ) ); AjaxResponse::outputAndExit(); } /* * * @param WPDashMsgs $wpDashMsgs * @param string $action * * @throws LSCMException Thrown when parameter $action value is * unrecognized. * @throws LSCMException Thrown indirectly by AjaxResponse::outputAndExit() * call. / protected function doWpDashMsgOperation( WPDashMsgs $wpDashMsgs, $action ) { if ( ($type = Util::get_request_var('msg_type')) !== NULL ) { $type = trim($type); } if ( ($msgId = Util::get_request_var('msg_id')) !== NULL ) { $msgId = trim($msgId); } switch ( $action ) { case WPDashMsgs::ACTION_GET_MSG: $msgs = $wpDashMsgs->getMsgData($type); $msgInfo = []; if ( $msgId !== '' && $msgId !== NULL && isset($msgs[$msgId]) ) { $msgInfo = $msgs[$msgId]; } $ajaxReturn = [ 'msgInfo' => $msgInfo ]; break; case WPDashMsgs::ACTION_ADD_MSG: if ( ($msg = Util::get_request_var('notify_msg')) !== NULL ) { $msg = trim($msg); } if ( ($slug = Util::get_request_var('notify_slug')) !== NULL ) { $slug = trim($slug); } $ret = 0; if ( $wpDashMsgs->addMsg($type, $msgId, $msg, $slug) ) { $ret = 1; } $ajaxReturn = [ 'ret' => $ret ]; break; case WPDashMsgs::ACTION_DELETE_MSG: $ajaxReturn = [ 'ret' => ($wpDashMsgs->deleteMsg($type, $msgId)) ? 1 : 0 ]; break; default: throw new LSCMException( 'PanelController->doWpDashMsgOperation(): Unrecognized ' . '$action value.' ); } AjaxResponse::setAjaxContent(json_encode($ajaxReturn)); AjaxResponse::outputAndExit(); } /* * * @param string $action * @param string $path * @param string $msgInfoJSON * * @throws LSCMException Thrown indirectly by AjaxResponse::outputAndExit() * call. * @throws LSCMException Thrown indirectly by * $this->wpInstallStorage->doAction() call. * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. * @throws LSCMException Thrown indirectly by AjaxResponse::outputAndExit() * call. / protected function doSingleDashAction( $action, $path, $msgInfoJSON = '' ) { if ( $this->wpInstallStorage->getWPInstall($path) === null ) { AjaxResponse::setAjaxContent( json_encode( [ 'errMsgs' => [ 'Invalid input value detected - Please use the ' . 'exact path displayed in the ' . '"Manage Cache Installations" list when ' . 'testing.' ], 'succMsgs' => [] ] ) ); AjaxResponse::outputAndExit(); } $this->wpInstallStorage->doAction($action, [ $path ], [ $msgInfoJSON ]); $msgs = $this->wpInstallStorage->getAllCmdMsgs(); AjaxResponse::setAjaxContent( json_encode( [ 'errMsgs' => array_merge( $msgs['fail'], $msgs['err'], Logger::getUiMsgs(Logger::UI_ERR) ), 'succMsgs' => array_merge( $msgs['succ'], Logger::getUiMsgs(Logger::UI_SUCC) ) ] ) ); AjaxResponse::outputAndExit(); } /* * * @param string $action * @param int $step * * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by $this->getBatchSize() call. * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. * @throws LSCMException Thrown indirectly by AjaxResponse::outputAndExit() * call. / public function massEnableDisable( $action, $step ) { if ( session_status() !== PHP_SESSION_ACTIVE ) { session_start(); } $actionUpper = ucfirst($action); $info = &$_SESSION["mass{$actionUpper}Info"]; switch ( $step ) { case 1: $info = [ 'installs' => $this->wpInstallStorage->getPaths() ]; break; case 2: $completedCount = -1; $succCount = $failCount = $bypassedCount = 0; if ( !isset($info['installs']) ) { Logger::uiError( 'Expected session data missing! Stopping mass ' . 'operation.' ); } else { $batchSize = $this->getBatchSize($info['installs']); $batch = array_splice($info['installs'], 0, $batchSize); try { $finishedList = $this->wpInstallStorage->doAction( "mass_$action", $batch ); $completedCount = count($finishedList); if ( $completedCount != $batchSize ) { $info['installs'] = array_merge( array_slice($batch, $completedCount), $info['installs'] ); } } catch ( LSCMException $e ) { Logger::uiError( "{$e->getMessage()} Stopping mass operation." ); $finishedList = $info['installs'] = []; } $workingQueue = $this->wpInstallStorage->getWorkingQueue(); foreach ( $finishedList as $path ) { $wpInstall = $this->wpInstallStorage->getWPInstall($path); if ( isset($workingQueue[$path]) ) { $cmdStatus = $workingQueue[$path]->getCmdStatus(); } else { $cmdStatus = $wpInstall->getCmdStatus(); } if ( $cmdStatus & UserCommand::EXIT_INCR_SUCC ) { $succCount++; } elseif ( $cmdStatus & UserCommand::EXIT_INCR_FAIL ) { $failCount++; } elseif ( $cmdStatus & UserCommand::EXIT_INCR_BYPASS \|\| $wpInstall->isFlagBitSet() ) { $bypassedCount++; } } } if ( empty($info['installs']) ) { unset($_SESSION["mass{$actionUpper}Info"]); } $msgs = $this->wpInstallStorage->getAllCmdMsgs(); AjaxResponse::setAjaxContent( json_encode( [ 'completed' => $completedCount, 'bypassedCount' => $bypassedCount, 'failCount' => $failCount, 'succCount' => $succCount, 'errMsgs' => array_merge( $msgs['fail'], $msgs['err'], Logger::getUiMsgs(Logger::UI_ERR) ), 'succMsgs' => array_merge( $msgs['succ'], Logger::getUiMsgs(Logger::UI_SUCC) ) ] ) ); AjaxResponse::outputAndExit(); break; // No default case } } /* * Force updates LiteSpeed Cache Plugins whose versions * match those in $verList and refreshes status as well. Flagged * installations are bypassed. * * @param int $step Value of 2 will prep session info, 3 will begin * changing installed LSCWP versions in batches. * * @return void * * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by $this->getBatchSize() call. * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. * @throws LSCMException Thrown indirectly by AjaxResponse::outputAndExit() * call. / public function prepVersionChange( $step ) { if ( session_status() !== PHP_SESSION_ACTIVE ) { session_start(); } $info = &$_SESSION['verInfo']; switch ( $step ) { case 2: /* * init upgrade / if ( empty( ($verList = Util::get_request_list('selectedVers')) ) ) { /* * Version list should not be empty / return; } $info = [ 'installs' => $this->wpInstallStorage->getPaths(), 'verNum' => Util::get_request_var('version_num'), 'verList' => $verList ]; break; case 3: $completedCount = -1; if ( !isset($info['installs']) ) { Logger::uiError( 'Expected session data missing! Stopping mass ' . 'operation.' ); } else { $batchSize = $this->getBatchSize($info['installs']); $batch = array_splice($info['installs'], 0, $batchSize); try { $completedCount = count( $this->wpInstallStorage->doAction( UserCommand::CMD_MASS_UPGRADE, $batch, /* * 1 => "from versions" (comma seperated), * 2 => "to version" / [ implode(',', $info['verList']), $info['verNum'] ] ) ); if ( $completedCount != $batchSize ) { $info['installs'] = array_merge( array_slice($batch, $completedCount), $info['installs'] ); } } catch ( LSCMException $e ) { Logger::uiError( "{$e->getMessage()} Stopping mass operation." ); $info['installs'] = []; } } if ( empty($info['installs']) \|\| $completedCount == -1 ) { unset($_SESSION['verInfo']); } $msgs = $this->wpInstallStorage->getAllCmdMsgs(); AjaxResponse::setAjaxContent( json_encode( [ 'completed' => $completedCount, 'errMsgs' => array_merge( $msgs['fail'], $msgs['err'], Logger::getUiMsgs(Logger::UI_ERR) ) ] ) ); AjaxResponse::outputAndExit(); break; } } /* * * @return bool\|void Function outputs ajax and exits without returning a * value when $init is evaluated to be false. * * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by $this->getBatchSize() call. * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. * @throws LSCMException Thrown indirectly by AjaxResponse::outputAndExit() * call. / protected function checkDashMassNotifyAction() { if ( $this->dashStep == self::DASH_STEP_MASS_DASH_NOTIFY ) { $init = false; } elseif ( Util::get_request_var('mass-notify') ) { $init = true; $this->dashStep = self::DASH_STEP_MASS_DASH_NOTIFY; } else { return false; } if ( session_status() !== PHP_SESSION_ACTIVE ) { session_start(); } $info = &$_SESSION['massDashNotifyInfo']; if ( $init ) { $info = [ 'installs' => $this->wpInstallStorage->getPaths(), 'msgInfo' => base64_encode($this->getDashMsgInfoJSON()) ]; return true; } $completedCount = -1; $succCount = $failCount = $bypassedCount = 0; if ( !isset($info['installs']) ) { Logger::uiError( 'Expected session data missing! Stopping mass operation.' ); } else { $batchSize = $this->getBatchSize($info['installs']); $batch = array_splice($info['installs'], 0, $batchSize); try { $finishedList = $this->wpInstallStorage->doAction( UserCommand::CMD_MASS_DASH_NOTIFY, $batch, [ $info['msgInfo'] ] ); $completedCount = count($finishedList); if ( $completedCount != $batchSize ) { $info['installs'] = array_merge( array_slice($batch, $completedCount), $info['installs'] ); } } catch ( LSCMException $e ) { Logger::uiError("{$e->getMessage()} Stopping mass operation."); $finishedList = $info['installs'] = []; } $workingQueue = $this->wpInstallStorage->getWorkingQueue(); foreach ( $finishedList as $path ) { $wpInstall = $this->wpInstallStorage->getWPInstall($path); if ( isset($workingQueue[$path]) ) { $cmdStatus = $workingQueue[$path]->getCmdStatus(); } else { $cmdStatus = $wpInstall->getCmdStatus(); } if ( $cmdStatus & UserCommand::EXIT_INCR_SUCC ) { $succCount++; } elseif ( $cmdStatus & UserCommand::EXIT_INCR_FAIL ) { $failCount++; } elseif ( $cmdStatus & UserCommand::EXIT_INCR_BYPASS \|\| $wpInstall->isFlagBitSet() ) { $bypassedCount++; } } } if ( empty($info['installs']) ) { unset($_SESSION['massDashNotifyInfo']); } $msgs = $this->wpInstallStorage->getAllCmdMsgs(); AjaxResponse::setAjaxContent( json_encode( [ 'completed' => $completedCount, 'bypassedCount' => $bypassedCount, 'failCount' => $failCount, 'succCount' => $succCount, 'errMsgs' => array_merge( $msgs['fail'], $msgs['err'], Logger::getUiMsgs(Logger::UI_ERR) ), 'succMsgs' => array_merge( $msgs['succ'], Logger::getUiMsgs(Logger::UI_SUCC) ) ] ) ); AjaxResponse::outputAndExit(); } /* * * @return bool\|void Function outputs ajax and exits without returning a * value when $init is evaluated to be false. * * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by $this->getBatchSize() call. * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. * @throws LSCMException Thrown indirectly by AjaxResponse::outputAndExit() * call. */ protected function checkDashMassDisableAction() { if ( $this->dashStep == self::DASH_STEP_MASS_DASH_DISABLE ) { $init = false; } elseif ( Util::get_request_var('mass-disable-dash-notifier') ) { $init = true; $this->dashStep = self::DASH_STEP_MASS_DASH_DISABLE; } else { return false; } if ( session_status() !== PHP_SESSION_ACTIVE ) { session_start(); } $info = &$_SESSION['massDashDisableInfo']; if ( $init ) { $info = [ 'installs' => $this->wpInstallStorage->getPaths() ]; return true; } $completedCount = -1; $succCount = $failCount = $bypassedCount = 0; if ( !isset($info['installs']) ) { Logger::uiError( 'Expected session data missing! Stopping mass operation.' ); } else { $batchSize = $this->getBatchSize($info['installs']); $batch = array_splice($info['installs'], 0, $batchSize); try { $finishedList = $this->wpInstallStorage->doAction( UserCommand::CMD_MASS_DASH_DISABLE, $batch ); $completedCount = count($finishedList); if ( $completedCount != $batchSize ) { $info['installs'] = array_merge( array_slice($batch, $completedCount), $info['installs'] ); } } catch ( LSCMException $e ) { Logger::uiError("{$e->getMessage()} Stopping mass operation."); $finishedList = $info['installs'] = []; } $workingQueue = $this->wpInstallStorage->getWorkingQueue(); foreach ( $finishedList as $path ) { $wpInstall = $this->wpInstallStorage->getWPInstall($path); if ( isset($workingQueue[$path]) ) { $cmdStatus = $workingQueue[$path]->getCmdStatus(); } else { $cmdStatus = $wpInstall->getCmdStatus(); } if ( $cmdStatus & UserCommand::EXIT_INCR_SUCC ) { $succCount++; } elseif ( $cmdStatus & UserCommand::EXIT_INCR_FAIL ) { $failCount++; } elseif ( $cmdStatus & UserCommand::EXIT_INCR_BYPASS \|\| $wpInstall->isFlagBitSet() ) { $bypassedCount++; } } } if ( empty($info['installs']) ) { unset($_SESSION['massDashDisableInfo']); } $msgs = $this->wpInstallStorage->getAllCmdMsgs(); AjaxResponse::setAjaxContent( json_encode( [ 'completed' => $completedCount, 'bypassedCount' => $bypassedCount, 'failCount' => $failCount, 'succCount' => $succCount, 'errMsgs' => array_merge( $msgs['fail'], $msgs['err'], Logger::getUiMsgs(Logger::UI_ERR) ), 'succMsgs' => array_merge( $msgs['succ'], Logger::getUiMsgs(Logger::UI_SUCC) ) ] ) ); AjaxResponse::outputAndExit(); } }	56.12 KB	2026-03-12 22:37
📄 PluginVersion.php <?php / ******************************************* * LiteSpeed Web Server Cache Manager * * @author Michael Alegre * @copyright 2018-2025 LiteSpeed Technologies, Inc. * ******************************************* / namespace Lsc\Wp; use Lsc\Wp\Context\Context; class PluginVersion { /* * @var string / const DEFAULT_PLUGIN_PATH = '/wp-content/plugins/litespeed-cache'; /* * @deprecated 1.9 * @var string / const DOWNLOAD_DIR = '/usr/src/litespeed-wp-plugin'; /* * @var string Old conf file name. / const LSCWP_DEFAULTS_INI_FILE_NAME = 'const.default.ini'; /* * @since 1.17.5 * @var string New conf file name. / const LSCWP_DEFAULTS_JSON_FILE_NAME = 'const.default.json'; /* * @var string / const PLUGIN_NAME = 'litespeed-cache'; /* * @var string / const TRANSLATION_CHECK_FLAG_BASE = '.ls_translation_check'; /* * @var string / const VER_MD5 = 'lscwp_md5'; /* * @deprecated 4.1.3 Will be removed in favor of $this->shortVersions. * @var string[] / protected $knownVersions = []; /* * @since 4.1.3 * @var string[] / protected $shortVersions = []; /* * @var string[] / protected $allowedVersions = array(); /* * @var string / protected $currVersion = ''; /* * @var string / protected $versionFile; /* * @var string / protected $activeFile; /* * @var null\|PluginVersion / protected static $instance; /* * * @throws LSCMException Thrown indirectly by $this->init() call. / protected function __construct() { $this->init(); } /* * * @throws LSCMException Thrown indirectly by Context::isPrivileged() call. * @throws LSCMException Thrown indirectly by $this->refreshVersionList() * call. / protected function init() { $this->setVersionFiles(); if ( Context::isPrivileged() ) { $this->refreshVersionList(); } } /* * * @return PluginVersion * * @throws LSCMException Thrown indirectly by Context::getOption() call. / public static function getInstance() { if ( self::$instance == null ) { $className = Context::getOption()->getLscwpVerClass(); self::$instance = new $className(); } return self::$instance; } /* * * @deprecated 4.1.3 Use "$formatted = true" equivalent function * $this->getShortVersions() instead. Un-formatted version of this list * will no longer be available once this function is removed. * * @param bool $formatted * * @return string[] * * @throws LSCMException Thrown indirectly by $this->setKnownVersions() * call. / public function getKnownVersions( $formatted = false ) { if ( empty($this->knownVersions) ) { $this->setKnownVersions(); } if ( $formatted ) { $knownVers = $this->knownVersions; $prevVer = ''; foreach ( $knownVers as &$ver ) { if ( $prevVer !== '' ) { $ver1 = explode('.', $prevVer); $ver2 = explode('.', $ver); if ( $ver1[0] !== $ver2[0] \|\| $ver1[1] !== $ver2[1] ) { $ver = "$ver2[0].$ver2[1].x"; } } $prevVer = $ver; } return $knownVers; } return $this->knownVersions; } /* * * @return string[] * * @throws LSCMException Thrown indirectly by $this->setAllowedVersions() * call. / public function getAllowedVersions() { if ( empty($this->allowedVersions) ) { $this->setAllowedVersions(); } return $this->allowedVersions; } /* * * @since 4.1.3 * * @return string[] * * @throws LSCMException Thrown indirectly by $this->setShortVersions() * call. / public function getShortVersions() { if ( empty($this->shortVersions) ) { $this->setShortVersions(); } return $this->shortVersions; } /* * * @return string * * @throws LSCMException Thrown indirectly by $this->getAllowedVersions() * call. / public function getLatestVersion() { $allowedVers = $this->getAllowedVersions(); return (isset($allowedVers[0])) ? $allowedVers[0] : ''; } /* * * @return string * * @throws LSCMException Thrown indirectly by self::getInstance() call. * @throws LSCMException Thrown indirectly by * $instance->setCurrentVersion() call. / public static function getCurrentVersion() { $instance = self::getInstance(); if ( $instance->currVersion == '' ) { $instance->setCurrentVersion(); } return $instance->currVersion; } /* * * @since 1.9 / protected function createDownloadDir() { mkdir(Context::LOCAL_PLUGIN_DIR, 0755); } protected function setVersionFiles() { $this->versionFile = Context::LOCAL_PLUGIN_DIR . '/lscwp_versions_v2'; $this->activeFile = Context::LOCAL_PLUGIN_DIR . '/lscwp_active_version'; } /* * Temporary function for handling the active version file and versions * file move in the short term. * * @deprecated 1.9 * @since 1.9 * * @throws LSCMException Thrown indirectly by Context::getLSCMDataDir() * call. / protected function checkOldVersionFiles() { $dataDir = Context::getLSCMDataDir(); $oldActiveFile = "$dataDir/lscwp_active_version"; if ( file_exists($oldActiveFile) ) { if ( !file_exists(Context::LOCAL_PLUGIN_DIR) ) { $this->createDownloadDir(); } rename($oldActiveFile, $this->activeFile); unlink("$dataDir/lscwp_versions"); } } /* * * @throws LSCMException Thrown indirectly by $this->checkOldVersionFiles() * call. * @throws LSCMException Thrown indirectly by Logger::debug() call. * @throws LSCMException Thrown indirectly by Logger::debug() call. * @throws LSCMException Thrown indirectly by Logger::debug() call. / public function setCurrentVersion() { $this->checkOldVersionFiles(); if ( ($activeVersion = $this->getActiveVersion()) == '' ) { Logger::debug('Active LSCWP version not found.'); } elseif ( ! $this->hasDownloadedVersion($activeVersion) ) { $activeVersion = ''; unlink($this->activeFile); Logger::debug('Valid LSCWP download not found.'); } if ( $activeVersion == '' ) { try { $activeVersion = self::getLatestVersion(); } catch ( LSCMException $e ) { Logger::debug($e->getMessage()); } } $this->currVersion = $activeVersion; } /* * * @since 1.11 * * @return string / private function getActiveVersion() { if ( file_exists($this->activeFile) && ($content = file_get_contents($this->activeFile)) ) { return trim($content); } return ''; } /* * * @deprecated 4.1.3 This function will be removed in favor of * pre-formatted $this->setShortVersions(). * * @throws LSCMException Thrown when LSCWP version list cannot be found. * @throws LSCMException Thrown when read LSCWP version list command fails. * @throws LSCMException Thrown when match against LSCWP version list * content fails. / protected function setKnownVersions() { if ( !file_exists($this->versionFile) ) { throw new LSCMException( 'Cannot find LSCWP version list.', LSCMException::E_NON_FATAL ); } if ( ($content = file_get_contents($this->versionFile)) === false ) { throw new LSCMException( 'Failed to read LSCWP version list content.', LSCMException::E_NON_FATAL ); } if ( preg_match('/old\s{(.)}/sU', trim($content), $m) != 1 ) { throw new LSCMException( 'Failed to get known versions from LSCWP version list content.', LSCMException::E_NON_FATAL ); } $this->knownVersions = explode("\n", trim($m[1])); } /** * * @throws LSCMException Thrown when LSCWP version list cannot be found. * @throws LSCMException Thrown when read LSCWP version list command fails. * @throws LSCMException Thrown when LSCWP version list content is empty. / protected function setAllowedVersions() { if ( !file_exists($this->versionFile) ) { throw new LSCMException( 'Cannot find LSCWP version list.', LSCMException::E_NON_FATAL ); } if ( ($content = file_get_contents($this->versionFile)) === false ) { throw new LSCMException( 'Failed to read LSCWP version list content.', LSCMException::E_NON_FATAL ); } if ( !preg_match('/allowed\s{(.)}/sU', trim($content), $m) \|\| ($list = trim($m[1])) == '' ) { throw new LSCMException( 'LSCWP version list is empty.', LSCMException::E_NON_FATAL ); } $this->allowedVersions = explode("\n", $list); } /** * * @since 4.1.3 * * @throws LSCMException Thrown when LSCWP version list cannot be found. * @throws LSCMException Thrown when read LSCWP version list command fails. * @throws LSCMException Thrown when LSCWP version list content is empty. / protected function setShortVersions() { if ( !file_exists($this->versionFile) ) { throw new LSCMException( 'Cannot find LSCWP version list.', LSCMException::E_NON_FATAL ); } if ( ($content = file_get_contents($this->versionFile)) === false ) { throw new LSCMException( 'Failed to read LSCWP version list content.', LSCMException::E_NON_FATAL ); } if ( !preg_match('/short\s{(.)}/sU', trim($content), $m) \|\| ($list = trim($m[1])) == '' ) { throw new LSCMException( 'LSCWP version list is empty.', LSCMException::E_NON_FATAL ); } $this->shortVersions = explode("\n", $list); } /** * * @param string $version Valid LSCWP version. * @param bool $init True when trying to set initial active version. * * @throws LSCMException Thrown indirectly by $this->getAllowedVersions() * call. * @throws LSCMException Thrown indirectly by Logger::error() call. * @throws LSCMException Thrown indirectly by $this->downloadVersion() * call. * @throws LSCMException Thrown indirectly by Logger::notice() call. / public function setActiveVersion( $version, $init = false ) { $allowedVers = $this->getAllowedVersions(); if ( in_array($version, $allowedVers) ) { $activeVer = $version; } else { try { $currVer = ($init) ? '' : $this->getCurrentVersion(); } catch ( LSCMException $e ) { $currVer = ''; } if ( $currVer != '' ) { $activeVer = $currVer; } else { $activeVer = $allowedVers[0]; } Logger::error( "Version $version not in allowed list, reset active " . "version to $activeVer." ); } if ( $activeVer != $this->getActiveVersion() ) { if ( !$this->hasDownloadedVersion($activeVer) ) { $this->downloadVersion($activeVer); } $this->currVersion = $activeVer; file_put_contents($this->activeFile, $activeVer); Logger::notice("Current active LSCWP version is now $activeVer."); } } /* * * @param bool $isForced * * @throws LSCMException Thrown indirectly by Logger::info() call. / protected function refreshVersionList( $isForced = false ) { clearstatcache(); if ( $isForced \|\| !file_exists($this->versionFile) \|\| (time() - filemtime($this->versionFile)) > 86400 ) { if ( !file_exists(Context::LOCAL_PLUGIN_DIR) ) { $this->createDownloadDir(); } $url = 'https://www.litespeedtech.com/packages/lswpcache' . '/version_list_v2'; $content = Util::get_url_contents($url); if ( empty($content) \|\| substr($content, 0, 7) != 'allowed' ) { /* * Try again using cli curl directly to bypass potential * reCAPTCHA issues. / $content = Util::getUrlContentsUsingExecCurl($url); if ( empty($content) \|\| substr($content, 0, 7) != 'allowed' ) { touch($this->versionFile); return; } } file_put_contents($this->versionFile, $content); Logger::info('LSCache for WordPress version list updated'); } } /* * Filter out any versionList versions that do not meet specific criteria. * * @deprecated 4.1.3 No longer used. * * @param string $ver Version string. * * @return bool / protected function filterVerList( $ver ) { return Util::betterVersionCompare($ver, '1.2.2', '>'); } /* * * @since 1.17.5 * * @param string $pluginDir The WordPress plugin directory. / public static function tryCopyLscwpDefaultConf( $pluginDir ) { foreach ( [ self::LSCWP_DEFAULTS_INI_FILE_NAME, self::LSCWP_DEFAULTS_JSON_FILE_NAME ] as $customConfFileName ) { $customConfFilePath = Context::LOCAL_PLUGIN_DIR . "/$customConfFileName"; if ( file_exists($customConfFilePath) ) { copy( $customConfFilePath, "$pluginDir/litespeed-cache/data/$customConfFileName" ); } } } /* * Checks the current installation for existing LSCWP plugin files and * copies them to the installation's plugins directory if not found. * This function should only be run as the user. * * @param string $pluginDir The WordPress plugin directory. * @param string $version The version of LSCWP to be used when copying * over plugin files. * * @return bool True when new LSCWP plugin files are used. * * @throws LSCMException Thrown when LSCWP source package is not available * for the provided version. * @throws LSCMException Thrown when LSCWP plugin files could not be copied * to plugin directory. * @throws LSCMException Thrown indirectly by self::getInstance() call. * @throws LSCMException Thrown indirectly by * $instance->getCurrentVersion() call. * @throws LSCMException Thrown indirectly by Logger::debug() call. / public static function prepareUserInstall( $pluginDir, $version = '' ) { $lscwp_plugin = "$pluginDir/litespeed-cache/litespeed-cache.php"; if ( file_exists($lscwp_plugin) ) { /* * Existing installation detected. / return false; } $instance = self::getInstance(); if ( $version == '' ) { $version = $instance->getCurrentVersion(); } if ( !$instance->hasDownloadedVersion($version) ) { throw new LSCMException( "Source Package not available for version $version.", LSCMException::E_NON_FATAL ); } exec( '/bin/cp --preserve=mode -rf ' . Context::LOCAL_PLUGIN_DIR . "/$version/" . self::PLUGIN_NAME . " $pluginDir" ); if ( !file_exists($lscwp_plugin) ) { throw new LSCMException( "Failed to copy plugin files to $pluginDir.", LSCMException::E_NON_FATAL ); } self::tryCopyLscwpDefaultConf($pluginDir); Logger::debug( 'Copied LSCache for WordPress plugin files into plugins directory ' . $pluginDir ); return true; } /* * * @param string $version * * @return bool / protected function hasDownloadedVersion( $version ) { $dir = Context::LOCAL_PLUGIN_DIR . "/$version"; $md5file = "$dir/" . self::VER_MD5; $plugin = "$dir/" . self::PLUGIN_NAME; if ( !file_exists($md5file) \|\| !is_dir($plugin) ) { return false; } return (file_get_contents($md5file) == Util::DirectoryMd5($plugin)); } /* * * @param string $version * @param string $dir * @param bool $saveMD5 * * @throws LSCMException Thrown when wget command for downloaded LSCWP * version fails. * @throws LSCMException Thrown when unable to unzip LSCWP zip file. * @throws LSCMException Thrown when unzipped LSCWP files do not contain * expected test file. * @throws LSCMException Thrown indirectly by Logger::info() call. * @throws LSCMException Thrown indirectly by Util::unzipFile() call. / protected function wgetPlugin( $version, $dir, $saveMD5 = false ) { Logger::info("Downloading LSCache for WordPress v$version..."); $zipFile = self::PLUGIN_NAME . ".$version.zip"; exec( 'wget -q --tries=1 --no-check-certificate ' . "https://downloads.wordpress.org/plugin/$zipFile -P $dir", $output, $return_var ); if ( $return_var !== 0 ) { throw new LSCMException( "Failed to download LSCWP v$version with wget exit status " . "$return_var.", LSCMException::E_NON_FATAL ); } $localZipFile = "$dir/$zipFile"; $extractedZip = Util::unzipFile($localZipFile, $dir); unlink($localZipFile); if ( !$extractedZip ) { throw new LSCMException( "Unable to unzip $localZipFile", LSCMException::E_NON_FATAL ); } $plugin = "$dir/" . self::PLUGIN_NAME; if ( !file_exists("$plugin/" . self::PLUGIN_NAME . '.php') ) { throw new LSCMException( "Test file not found. Downloaded LSCWP v$version is invalid.", LSCMException::E_NON_FATAL ); } if ( $saveMD5 ) { file_put_contents( "$dir/" . self::VER_MD5, Util::DirectoryMd5($plugin) ); } } /* * * @param string $version * * @throws LSCMException Thrown when download dir could not be created. * @throws LSCMException Thrown indirectly by $this->wgetPlugin() call. / protected function downloadVersion( $version ) { $dir = Context::LOCAL_PLUGIN_DIR . "/$version"; if ( !file_exists($dir) ) { if ( !mkdir($dir, 0755, true) ) { throw new LSCMException( "Failed to create download dir $dir.", LSCMException::E_NON_FATAL ); } } else { exec("/bin/rm -rf $dir/"); } $this->wgetPlugin($version, $dir, true); } /** * * @param string $locale * @param string $pluginVer * * @return bool * * @throws LSCMException Thrown indirectly by Logger::info() call. * @throws LSCMException Thrown indirectly by Util::unzipFile() call. / public static function retrieveTranslation( $locale, $pluginVer ) { Logger::info( "Downloading LSCache for WordPress $locale translation..." ); $translationDir = Context::LOCAL_PLUGIN_DIR . "/$pluginVer/translations"; if ( !file_exists($translationDir) ) { mkdir($translationDir, 0755); } touch( "$translationDir/" . self::TRANSLATION_CHECK_FLAG_BASE . "_$locale" ); /* * downloads.wordpress.org looks to always return a '200 OK' status, * even when serving a 404 page. As such invalid downloads can only be * checked through user failure to unzip through WP func unzip_file() * as we do not assume that root has the ability to unzip. / exec( 'wget -q --tries=1 --no-check-certificate ' . 'https://downloads.wordpress.org/translation/plugin/' . "litespeed-cache/$pluginVer/$locale.zip -P $translationDir", $output, $return_var ); if ( $return_var !== 0 ) { return false; } /* * The WordPress user can unzip for us if this call fails. / Util::unzipFile("$translationDir/$locale.zip", $translationDir); return true; } /* * * @param string $locale * @param string $pluginVer * * @throws LSCMException Thrown indirectly by Logger::info() call. */ public static function removeTranslationZip( $locale, $pluginVer ) { Logger::info("Removing LSCache for WordPress $locale translation..."); $zipFile = realpath( Context::LOCAL_PLUGIN_DIR . "/$pluginVer/translations/$locale.zip" ); if ( substr($zipFile, 0, strlen(Context::LOCAL_PLUGIN_DIR)) === Context::LOCAL_PLUGIN_DIR ) { unlink($zipFile); } } }	22.58 KB	2026-03-12 22:37
📄 RedefineGlobalFuncs.php <?php / ******************************************* * LiteSpeed Web Server Cache Manager * * @author LiteSpeed Technologies, Inc. (https://www.litespeedtech.com) * @copyright (c) 2021 * @since 1.13.10 * ******************************************* / /* * As of PHP 8.x, functions disabled using ini directive 'disable_functions' * are no longer included in PHP's functions table and must be redefined to * avoid fatal error "Call to undefined function" when called. * * This file is used to redefine internal PHP functions intentionally disabled * before loading the WordPress environment. / if ( !function_exists('ini_set') ) { /* * * @since 1.13.10 * * @param string $option * @param string $value * * @return false */ function ini_set( $option, $value) { return false; } }	865 B	2026-03-12 22:37
📁 ThirdParty	-	2026-03-12 22:37
📄 UserCommand.php <?php / ******************************************* * LiteSpeed Web Server Cache Manager * * @author Michael Alegre * @copyright (c) 2018-2023 LiteSpeed Technologies, Inc. * ******************************************* / namespace Lsc\Wp; use Exception; use Lsc\Wp\Context\Context; use Lsc\Wp\Context\ContextOption; use Lsc\Wp\Context\UserCLIContextOption; use Lsc\Wp\Panel\ControlPanel; /* * Running as user - suexec / class UserCommand { /* * @var int / const EXIT_ERROR = 1; /* * @var int / const EXIT_SUCC = 2; /* * @var int / const EXIT_FAIL = 4; /* * @var int / const EXIT_INCR_SUCC = 8; /* * @var int / const EXIT_INCR_FAIL = 16; /* * @var int / const EXIT_INCR_BYPASS = 32; /* * @var int / const RETURN_CODE_TIMEOUT = 124; /* * @var string / const CMD_STATUS = 'status'; /* * @var string / const CMD_ENABLE = 'enable'; /* * @var string / const CMD_DIRECT_ENABLE = 'direct_enable'; /* * @var string / const CMD_MASS_ENABLE = 'mass_enable'; /* * @var string / const CMD_DISABLE = 'disable'; /* * @var string / const CMD_MASS_DISABLE = 'mass_disable'; /* * @var string / const CMD_UPGRADE = 'upgrade'; /* * @var string / const CMD_MASS_UPGRADE = 'mass_upgrade'; /* * @var string / const CMD_UPDATE_TRANSLATION = 'update_translation'; /* * @var string / const CMD_REMOVE_LSCWP_PLUGIN_FILES = 'remove_lscwp_plugin_files'; /* * @var string / const CMD_DASH_NOTIFY = 'dash_notify'; /* * @var string / const CMD_MASS_DASH_NOTIFY = 'mass_dash_notify'; /* * @var string / const CMD_DASH_DISABLE = 'dash_disable'; /* * @var string / const CMD_MASS_DASH_DISABLE = 'mass_dash_disable'; /* * @var string / const CMD_DASH_GET_MSG = 'dash_get_msg'; /* * @var string / const CMD_DASH_ADD_MSG = 'dash_add_msg'; /* * @var string / const CMD_DASH_DELETE_MSG = 'dash_delete_msg'; /* * @since 1.12 * @var string / const CMD_GET_QUICCLOUD_API_KEY = 'getQuicCloudApiKey'; /* * @var bool / private $asUser; /* * @var WPInstall / private $currInstall; /* * @var string / private $action; /* * @var string[] / private $extraArgs; /* * * @param bool $asUser * * @throws LSCMException Thrown indirectly by Context::initialize() call. / private function __construct( $asUser = false ) { if ( ($this->asUser = $asUser) ) { require_once __DIR__ . '/../autoloader.php'; date_default_timezone_set('UTC'); Context::initialize(new UserCLIContextOption('userCommand')); } } /* * Handles logging unexpected error output (or not if too long) and returns * a crafted message to be displayed instead. * * @param WPInstall $wpInstall WordPress Installation object. * @param string $err Compiled error message. * @param int $lines Number of $output lines read into the error * msg. * * @return string Message to be displayed instead. * * @throws LSCMException Thrown indirectly by Logger::error() call. * @throws LSCMException Thrown indirectly by Logger::error() call. / private static function handleUnexpectedError( WPInstall $wpInstall, $err, $lines ) { $msg = 'Unexpected Error Encountered!'; $path = $wpInstall->getPath(); /* * $lines > 500 are likely some custom code triggering a page render. * Throw out actual message in this case. / if ( $lines < 500 ) { $match = false; $commonErrs = array( WPInstall::ST_ERR_EXECMD_DB => 'Error establishing a database connection' ); foreach ( $commonErrs as $statusBit => $commonErr ) { if ( strpos($err, $commonErr) !== false ) { $wpInstall->unsetStatusBit(WPInstall::ST_ERR_EXECMD); $wpInstall->setStatusBit($statusBit); $msg .= " $commonErr."; $match = true; break; } } if ( !$match ) { Logger::error("$path - $err"); return "$msg See " . ContextOption::LOG_FILE_NAME . " for more information."; } } Logger::error("$path - $msg"); return $msg; } /* * Parse out locale and plugin version information from issue() result * output GET_TRANSLATION or BAD_TRANSLATION line. * * @since 1.14 * * @param string $line * * @return string[] / private static function parseTranslationLocaleAndPluginVer( $line ) { list($locale, $pluginVer) = explode(' ', $line); return array( 'locale' => $locale, 'pluginVer' => $pluginVer ); } /* * * @since 1.9 * * @param WPInstall $wpInstall * @param string $output * * @throws LSCMException Thrown indirectly by * PluginVersion::retrieveTranslation() call. * @throws LSCMException Thrown indirectly by self::subCommandIssue() call. * @throws LSCMException Thrown indirectly by * PluginVersion::removeTranslationZip() call. / private static function handleGetTranslationOutput( WPInstall $wpInstall, $output ) { $translationInfo = self::parseTranslationLocaleAndPluginVer($output); $translationRetrieved = PluginVersion::retrieveTranslation( $translationInfo['locale'], $translationInfo['pluginVer'] ); if ( $translationRetrieved ) { $subOutput = self::subCommandIssue(self::CMD_UPDATE_TRANSLATION, $wpInstall); foreach ( $subOutput as $subLine ) { if ( preg_match('/BAD_TRANSLATION=(.+)/', $subLine, $m) ) { $badTranslationInfo = self::parseTranslationLocaleAndPluginVer($m[1]); PluginVersion::removeTranslationZip( $badTranslationInfo['locale'], $badTranslationInfo['pluginVer'] ); } } } } /* * * @since 1.9 * * @param WPInstall $wpInstall * @param string $line * @param int $retStatus * @param int $cmdStatus * @param string $err * * @return bool * * @throws LSCMException Thrown indirectly by * $wpInstall->populateDataFromUrl() call. * @throws LSCMException Thrown indirectly by * self::handleGetTranslationOutput() call. / private static function handleResultOutput( WPInstall $wpInstall, $line, &$retStatus, &$cmdStatus, &$err ) { if ( preg_match('/SITEURL=(.+)/', $line, $m) ) { if ( !$wpInstall->populateDataFromUrl($m[1]) ) { /* * Matching docroot could not be found, ignore other * output. setCmdStatusAndMsg() etc already handled in * setSiteUrl(). / return false; } } elseif ( preg_match('/STATUS=(.+)/', $line, $m) ) { $retStatus = (int)$m[1]; } elseif ( preg_match('/MASS_INCR=(.+)/', $line, $m) ) { if ( $m[1] == 'SUCC' ) { $cmdStatus \|= UserCommand::EXIT_INCR_SUCC; } elseif ( $m[1] == 'FAIL' ) { $cmdStatus \|= UserCommand::EXIT_INCR_FAIL; } elseif( $m[1] = 'BYPASS' ) { $cmdStatus \|= UserCommand::EXIT_INCR_BYPASS; } } elseif ( preg_match('/GET_TRANSLATION=(.+)/', $line, $m) ) { self::handleGetTranslationOutput($wpInstall, $m[1]); } else { $err .= "Unexpected result line: $line\n"; } return true; } /* * * @since 1.9 * * @param WPInstall $wpInstall * * @throws LSCMException Thrown indirectly by self::subCommandIssue() call. / private static function removeLeftoverLscwpFiles( WPInstall $wpInstall ) { self::subCommandIssue(self::CMD_REMOVE_LSCWP_PLUGIN_FILES, $wpInstall); $wpInstall->removeNewLscwpFlagFile(); } /* * * @param string $action * @param WPInstall $wpInstall * @param array $extraArgs * * @return string * * @throws LSCMException Thrown indirectly by $wpInstall->getPhpBinary() * call. * @throws LSCMException Thrown indirectly by Context::getOption() call. / protected static function getIssueCmd( $action, WPInstall $wpInstall, array $extraArgs = array() ) { $su = $wpInstall->getSuCmd(); $timeout = ControlPanel::PHP_TIMEOUT; $phpBin = $wpInstall->getPhpBinary(); $path = $wpInstall->getPath(); $serverName = $wpInstall->getData(WPInstall::FLD_SERVERNAME); $env = Context::getOption()->getInvokerName(); if ( $serverName === null ) { $serverName = $docRoot = 'x'; } else { $docRoot = $wpInstall->getData(WPInstall::FLD_DOCROOT); if ( $docRoot === null ) { $docRoot = 'x'; } } $modifier = implode(' ', $extraArgs); $file = __FILE__; return "$su -c \"cd $path/wp-admin && timeout $timeout $phpBin $file " . "$action $path $docRoot $serverName $env" . (($modifier !== '') ? " $modifier\"" : '"'); } /* * * @since 1.12 * * @param string $action * @param WPInstall $wpInstall * @param string[] $extraArgs * * @return null\|string * * @throws LSCMException Thrown indirectly by self::preIssueValidation() * call. * @throws LSCMException Thrown indirectly by self::getIssueCmd() call. * @throws LSCMException Thrown indirectly by Logger::debug() call. * @throws LSCMException Thrown indirectly by Logger::debug() call. * @throws LSCMException Thrown indirectly by Logger::logMsg() call. * @throws LSCMException Thrown indirectly by Logger::logMsg() call. / public static function getValueFromWordPress( $action, WPInstall $wpInstall, array $extraArgs = array() ) { if ( !self::preIssueValidation($action, $wpInstall, $extraArgs) ) { return null; } $cmd = self::getIssueCmd($action, $wpInstall, $extraArgs); exec($cmd, $output, $return_var); Logger::debug( "getValueFromWordPress command $action=$return_var $wpInstall\n$cmd" ); Logger::debug('output = ' . var_export($output, true)); $ret = null; $debug = $upgrade = $err = ''; $curr = &$err; foreach ( $output as $line ) { /* * If this line is not present in output, did not return normally. * This line will appear after any [UPGRADE] output. / if ( strpos($line, 'LS UserCommand Output Start') !== false ) { continue; } elseif ( strpos($line, '[RESULT]') !== false ) { if ( preg_match('/API_KEY=(.+)/', $line, $m) ) { $ret = $m[1]; } else { $err .= "Unexpected result line $line\n"; } } elseif ( ($pos = strpos($line, '[DEBUG]')) !== false ) { $debug .= substr($line, $pos + 7) . "\n"; $curr = &$debug; } elseif ( strpos($line, '[UPGRADE]') !== false ) { //Ignore this output $curr = &$upgrade; } else { $curr .= "$line\n"; } } $path = $wpInstall->getPath(); if ( $debug ) { Logger::logMsg("$path - $debug", Logger::L_DEBUG); } if ( $err ) { Logger::logMsg("$path - $err", Logger::L_ERROR); } return $ret; } /* * * @since 1.14 * * @param string $subAction * @param WPInstall $wpInstall * * @return string[] * * @throws LSCMException Thrown indirectly by self::getIssueCmd() call. * @throws LSCMException Thrown indirectly by Logger::debug() call. * @throws LSCMException Thrown indirectly by Logger::debug() call. / private static function subCommandIssue( $subAction, WPInstall $wpInstall ) { $subCmd = self::getIssueCmd($subAction, $wpInstall); exec($subCmd, $subOutput, $subReturn_var); Logger::debug( "Issue sub command $subAction=$subReturn_var $wpInstall\n$subCmd" ); Logger::debug('sub output = ' . var_export($subOutput, true)); return $subOutput; } /* * * @param string $action * @param WPInstall $wpInstall * @param string[] $extraArgs * * @return bool * * @throws LSCMException Thrown indirectly by self::preIssueValidation() * call. * @throws LSCMException Thrown indirectly by self::getIssueCmd() call. * @throws LSCMException Thrown indirectly by Logger::debug() call. * @throws LSCMException Thrown indirectly by Logger::debug() call. * @throws LSCMException Thrown indirectly by * self::removeLeftoverLscwpFiles() call. * @throws LSCMException Thrown indirectly by self::handleResultOutput() * call. * @throws LSCMException Thrown indirectly by Logger::logMsg() call. * @throws LSCMException Thrown indirectly by Logger::logMsg() call. * @throws LSCMException Thrown indirectly by $wpInstall->addUserFlagFile() * call. * @throws LSCMException Thrown indirectly by Logger::error() call. * @throws LSCMException Thrown indirectly by self::handleUnexpectedError() * call. / public static function issue( $action, WPInstall $wpInstall, array $extraArgs = array() ) { if ( !self::preIssueValidation($action, $wpInstall, $extraArgs) ) { return false; } $cmd = self::getIssueCmd($action, $wpInstall, $extraArgs); exec($cmd, $output, $return_var); Logger::debug( "Issue command $action=$return_var $wpInstall\n$cmd" ); Logger::debug('output = ' . var_export($output, true)); if ( $wpInstall->hasNewLscwpFlagFile() ) { self::removeLeftoverLscwpFiles($wpInstall); } $errorStatus = $retStatus = $cmdStatus = 0; switch ( $return_var ) { case UserCommand::RETURN_CODE_TIMEOUT: $errorStatus \|= WPInstall::ST_ERR_TIMEOUT; break; case UserCommand::EXIT_ERROR: case 255: $errorStatus \|= WPInstall::ST_ERR_EXECMD; break; //no default } $isExpectedOutput = false; $unexpectedLines = 0; $succ = $upgrade = $err = $msg = $logMsg = ''; $logLvl = -1; $curr = &$err; foreach ( $output as $line ) { /* * If this line is not present in output, did not return normally. * This line will appear after any [UPGRADE] output. / if ( strpos($line, 'LS UserCommand Output Start') !== false ) { $isExpectedOutput = true; } elseif ( strpos($line, '[RESULT]') !== false ) { $ret = self::handleResultOutput( $wpInstall, $line, $retStatus, $cmdStatus, $err ); if ( !$ret ) { /* * Problem handling RESULT output, ignore other output. / return false; } } elseif ( ($pos = strpos($line, '[SUCCESS]')) !== false ) { $succ .= substr($line, $pos + 9) . "\n"; $curr = &$succ; } elseif ( ($pos = strpos($line, '[ERROR]')) !== false ) { $err .= substr($line, $pos + 7) . "\n"; $curr = &$err; } elseif ( strpos($line, '[LOG]') !== false ) { if ( $logMsg != '' ) { Logger::logMsg(trim($logMsg), $logLvl); $logMsg = ''; } if ( preg_match('/\[(\d+)] (.+)/', $line, $m) ) { $logLvl = $m[1]; $logMsg = "{$wpInstall->getPath()} - $m[2]\n"; } $curr = &$logMsg; } elseif ( strpos($line, '[UPGRADE]') !== false ) { /* * Ignore this output / $curr = &$upgrade; } else { if ( !$isExpectedOutput ) { $line = htmlentities($line); $unexpectedLines++; } $curr .= "$line\n"; } } if ( $logMsg != '' ) { Logger::logMsg(trim($logMsg), $logLvl); } if ( !$isExpectedOutput && !$errorStatus ) { $errorStatus \|= WPInstall::ST_ERR_EXECMD; } if ( $errorStatus ) { $wpInstall->addUserFlagFile(false); $errorStatus \|= WPInstall::ST_FLAGGED; $cmdStatus \|= UserCommand::EXIT_INCR_FAIL; } $newStatus = ($errorStatus \| $retStatus); if ( $newStatus != 0 ) { $wpInstall->setStatus($newStatus); } if ( $succ ) { $cmdStatus \|= UserCommand::EXIT_SUCC; $msg = $succ; } if ( $err ) { if ( $return_var == UserCommand::EXIT_FAIL ) { $cmdStatus \|= UserCommand::EXIT_FAIL; } else { $cmdStatus \|= UserCommand::EXIT_ERROR; } if ( $isExpectedOutput ) { $msg = $err; Logger::error("{$wpInstall->getPath()} - $err"); } else { $msg = self::handleUnexpectedError( $wpInstall, $err, $unexpectedLines ); } } $wpInstall->setCmdStatusAndMsg($cmdStatus, $msg); return true; } /* * * @param string[] $args * * @return null\|WPInstall / public static function newFromCmdArgs( array &$args ) { if ( !($wpPath = array_shift($args)) \|\| !($docRoot = array_shift($args)) \|\| !($serverName = array_shift($args)) ) { return null; } if ( !is_dir($wpPath) ) { return null; } /* * LSCWP_REF used by LSCWP plugin. / Util::define_wrapper('LSCWP_REF', array_shift($args)); $install = new WPInstall($wpPath); if ( $docRoot != 'x' ) { $install->setDocRoot($docRoot); } if ( $serverName != 'x' ) { $install->setServerName($serverName); } return $install; } /* * * @param string $action * @param WPInstall $wpInstall * @param string[] $extraArgs Not used at the moment. * * @return bool * * @throws LSCMException Thrown when $action value is unsupported. * @throws LSCMException Thrown indirectly by $wpInstall->hasValidPath() * call. * @throws LSCMException Thrown indirectly by Logger::debug() call. * @throws LSCMException Thrown indirectly by $wpInstall->refreshStatus() * call. * @throws LSCMException Thrown indirectly by $wpInstall->addUserFlagFile() * call. * @throws LSCMException Thrown indirectly by Logger::debug() call. * @throws LSCMException Thrown indirectly by * DashNotifier::prepLocalDashPluginFiles() call. * * @noinspection PhpUnusedParameterInspection / private static function preIssueValidation( $action, WPInstall $wpInstall, array $extraArgs ) { if ( !self::isSupportedIssueCmd($action) ) { throw new LSCMException( "Illegal action $action.", LSCMException::E_PROGRAM ); } if ( !$wpInstall->hasValidPath() ) { return false; } switch ( $action ) { case self::CMD_MASS_ENABLE: case self::CMD_MASS_DISABLE: case self::CMD_MASS_UPGRADE: if ( $wpInstall->hasFlagFile() ) { Logger::debug( "Bypass mass operation for flagged install $wpInstall" ); return false; } //fallthrough case self::CMD_MASS_DASH_NOTIFY: case self::CMD_MASS_DASH_DISABLE: if ( $wpInstall->hasFatalError() ) { $wpInstall->refreshStatus(); if ( $wpInstall->hasFatalError() ) { $wpInstall->addUserFlagFile(false); Logger::debug( 'Bypassed mass operation for error install and ' . "flagged $wpInstall" ); return false; } } //no default } if ( $action == self::CMD_DASH_NOTIFY \|\| $action == self::CMD_MASS_DASH_NOTIFY ) { DashNotifier::prepLocalDashPluginFiles(); } return true; } /* * * @since 1.9 Changed echoed output format to include "[LOG][$lvl] $msg". * Stopped echoing "[DEBUG] $msg" output. * * @return int / private function runAsUser() { try { $ret = 0; if ( $this->action == self::CMD_REMOVE_LSCWP_PLUGIN_FILES ) { $proc = WPCaller::getInstance($this->currInstall, false); $proc->removeLscwpPluginFiles(); $ret = self::EXIT_SUCC; } else { $proc = WPCaller::getInstance($this->currInstall); switch ( $this->action ) { case self::CMD_STATUS: $ret = $proc->updateStatus(true); break; case self::CMD_ENABLE: $ret = $proc->enable($this->extraArgs); $this->currInstall->removeNewLscwpFlagFile(); break; case self::CMD_DIRECT_ENABLE: $ret = $proc->directEnable(); $this->currInstall->removeNewLscwpFlagFile(); break; case self::CMD_MASS_ENABLE: $ret = $proc->massEnable($this->extraArgs); $this->currInstall->removeNewLscwpFlagFile(); break; case self::CMD_DISABLE: $ret = $proc->disable($this->extraArgs); break; case self::CMD_MASS_DISABLE: $ret = $proc->massDisable($this->extraArgs); break; case self::CMD_UPGRADE: $ret = $proc->upgrade($this->extraArgs); break; case self::CMD_MASS_UPGRADE: $ret = $proc->massUpgrade($this->extraArgs); break; case self::CMD_UPDATE_TRANSLATION: $proc->updateTranslationFiles(); $ret = self::EXIT_SUCC; break; case self::CMD_DASH_NOTIFY: $ret = $proc->dashNotify($this->extraArgs); break; case self::CMD_MASS_DASH_NOTIFY: $ret = $proc->massDashNotify($this->extraArgs); break; case self::CMD_DASH_DISABLE: $ret = $proc->dashDisable($this->extraArgs); break; case self::CMD_MASS_DASH_DISABLE: $ret = $proc->massDashDisable($this->extraArgs); break; case self::CMD_GET_QUICCLOUD_API_KEY: $proc->getQuicCloudAPIKey(true); $ret = self::EXIT_SUCC; break; //no default } } echo "LS UserCommand Output Start\n"; foreach ( $proc->getOutputResult() as $key => $value ) { echo "[RESULT] $key=$value\n"; } foreach ( Logger::getUiMsgs(Logger::UI_SUCC) as $msg ) { echo "[SUCCESS] $msg\n"; } foreach ( Logger::getUiMsgs(Logger::UI_ERR) as $msg ) { echo "[ERROR] $msg\n"; } foreach ( Logger::getLogMsgQueue() as $logEntry ) { $lvl = $logEntry->getLvl(); $msg = $logEntry->getMsg(); echo "[LOG][$lvl] $msg\n"; } } catch ( Exception $e ) { $ret = UserCommand::EXIT_ERROR; if ( $e instanceof LSCMException && $e->getCode() == LSCMException::E_NON_FATAL ) { $ret = UserCommand::EXIT_FAIL; } echo "LS UserCommand Output Start\n"; echo "[ERROR] {$e->getMessage()}\n"; } return $ret; } /* * * @param string $action * * @return bool / private static function isSupportedIssueCmd( $action ) { $supported = array( self::CMD_STATUS, self::CMD_ENABLE, self::CMD_DIRECT_ENABLE, self::CMD_MASS_ENABLE, self::CMD_DISABLE, self::CMD_MASS_DISABLE, self::CMD_UPGRADE, self::CMD_MASS_UPGRADE, self::CMD_UPDATE_TRANSLATION, self::CMD_REMOVE_LSCWP_PLUGIN_FILES, self::CMD_DASH_NOTIFY, self::CMD_MASS_DASH_NOTIFY, self::CMD_DASH_DISABLE, self::CMD_MASS_DASH_DISABLE, self::CMD_GET_QUICCLOUD_API_KEY ); return in_array($action, $supported); } /* * * @param string[] $args * * @return bool / private function initArgs( $args ) { $action = array_shift($args); if ( self::isSupportedIssueCmd($action) ) { $this->action = $action; if ( $install = self::newFromCmdArgs($args) ) { $this->currInstall = $install; $this->extraArgs = $args; return true; } } return false; } /* * * @return UserCommand * * @throws LSCMException Thrown indirectly by "new self()" call. * * @noinspection PhpDocRedundantThrowsInspection / private static function getUserCommand() { /* * Check if invoked from shell. / if ( empty($_SERVER['argv']) ) { return null; } $args = $_SERVER['argv']; if ( array_shift($args) != __FILE__ ) { return null; } $instance = new self(true); if ( !$instance->initArgs($args) ) { echo 'illegal input ' . implode(' ', $_SERVER['argv']); exit(self::EXIT_ERROR); } return $instance; } /* * * @throws LSCMException Thrown indirectly by self::getUserCommand() call. / public static function run() { if ( $cmd = self::getUserCommand() ) { if ( !defined('LSCM_RUN_AS_USER') ) { Util::define_wrapper('LSCM_RUN_AS_USER', 1); } $ret = $cmd->runAsUser(); exit($ret); } } } /* * This should only be invoked from command line. * * @noinspection PhpUnhandledExceptionInspection */ UserCommand::run();	28.72 KB	2026-03-12 22:37
📄 Util.php <?php / ******************************************* * LiteSpeed Web Server Cache Manager * * @author Michael Alegre * @copyright 2018-2025 LiteSpeed Technologies, Inc. * ******************************************* / namespace Lsc\Wp; use ZipArchive; class Util { /* * * @param string $tag * * @return string / public static function get_request_var( $tag ) { if ( isset($_REQUEST[$tag]) ) { return trim($_REQUEST[$tag]); } /* * Request var not found in $_REQUEST, try checking POST and * QUERY_STRING environment variables. / if ( $_SERVER['REQUEST_METHOD'] === 'POST' ) { $querystring = urldecode(getenv('POST')); } else { $querystring = urldecode(getenv('QUERY_STRING')); } if ( $querystring != '' && preg_match("/(?:^\|\?\|&)$tag=([^&]+)/", $querystring, $m) ) { return trim($m[1]); } return null; } /* * * @param string $tag * * @return array / public static function get_request_list( $tag ) { $varValue = null; if ( isset($_REQUEST[$tag]) ) { $varValue = $_REQUEST[$tag]; } else { /* * Request var not found in $_REQUEST, try checking POST and * QUERY_STRING environment variables. / if ( $_SERVER['REQUEST_METHOD'] === 'POST' ) { $querystring = urldecode(getenv('POST')); } else { $querystring = urldecode(getenv('QUERY_STRING')); } if ( $querystring != '' && preg_match_all("/(?:^\|\?\|&)$tag\[]=([^&]+)/", $querystring, $m) ) { $varValue = $m[1]; } } return (is_array($varValue)) ? $varValue : null; } /* * * @throws LSCMException Thrown indirectly by Logger::info() call. / public static function restartLsws() { Logger::info('Performing a Graceful Restart to apply changes...'); /* * @noinspection PhpMethodParametersCountMismatchInspection Suppress * for PHP 5.x. / if ( php_uname('s') == 'FreeBSD' ) { $lswsCtl = '/usr/local/etc/rc.d/lsws.sh'; } else { $lswsCtl = '/sbin/service lsws'; } exec("$lswsCtl restart"); } /* * @since 2.1.15 * * @param int $startTime * @param int $timeout * * @return bool / public static function timedOut( $startTime, $timeout ) { return ((time() - $startTime) > $timeout); } /* * This function is used to get the file owner by name. Useful in cases * where UID is not accepted or setting a files group to match its owner * (It is not safe to assume UID == GID or GID exists for username 'x'). * * @since 2.2.0 * * @param string $filepath * * @return array Keys are id, name, group_id / public static function populateOwnerInfo( $filepath ) { clearstatcache(); $ownerID = fileowner($filepath); $ownerInfo = posix_getpwuid($ownerID); return array( 'user_id' => $ownerID, 'user_name' => $ownerInfo['name'], 'group_id' => filegroup($filepath) ); } /* * * @param string $file * @param string $owner * @param string $group / public static function changeUserGroup( $file, $owner, $group ) { chown($file, $owner); chgrp($file, $group); } /* * Set file permissions of $file2 to match those of $file1. * * @since 2.2.0 * * @param string $file1 * @param string $file2 / public static function matchPermissions( $file1, $file2 ) { /* * convert fileperms() returned dec to oct / chmod($file2, (fileperms($file1) & 0777)); } /* * * @since 1.14.3 * * @param string $url * @param bool $headerOnly * * @return string / public static function getUrlContentsUsingFileGetContents( $url, $headerOnly = false ) { if ( ini_get('allow_url_fopen') ) { /* * silence warning when OpenSSL missing while getting LSCWP ver * file. / $url_content = @file_get_contents($url); if ( $url_content !== false ) { if ( $headerOnly ) { return implode("\n", $http_response_header); } return $url_content; } } return ''; } /* * * @since 1.14.3 * * @param string $url * @param bool $headerOnly * * @return string / public static function getUrlContentsUsingPhpCurl( $url, $headerOnly = false ) { if ( function_exists('curl_version') ) { $ch = curl_init(); curl_setopt_array( $ch, array( CURLOPT_URL => $url, CURLOPT_RETURNTRANSFER => true, CURLOPT_HEADER => $headerOnly, CURLOPT_NOBODY => $headerOnly, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1 ) ); $url_content = curl_exec($ch); curl_close($ch); if ( $url_content !== false ) { return $url_content; } } return ''; } /* * * @since 1.14.3 * * @param string $url * @param string $headerOnly * * @return string / public static function getUrlContentsUsingExecCurl( $url, $headerOnly = false ) { $cmd = 'curl -s'; if ( $headerOnly ) { $cmd .= ' -I'; } exec("$cmd $url", $output, $ret); if ( $ret === 0 ) { return implode("\n", $output); } return ''; } /* * * @param string $url * @param bool $headerOnly * * @return string / public static function get_url_contents( $url, $headerOnly = false ) { $content = self::getUrlContentsUsingFileGetContents($url, $headerOnly); if ( $content != '' ) { return $content; } $content = self::getUrlContentsUsingPhpCurl($url, $headerOnly); if ( $content != '' ) { return $content; } return self::getUrlContentsUsingExecCurl($url, $headerOnly); } /* * * @param string $dir * * @return false\|string / public static function DirectoryMd5( $dir ) { if ( !is_dir($dir) ) { return false; } $fileMd5s = array(); $d = dir($dir); while ( ($entry = $d->read()) !== false ) { if ( $entry != '.' && $entry != '..' ) { $currEntry = "$dir/$entry"; if ( is_dir($currEntry) ) { $fileMd5s[] = self::DirectoryMd5($currEntry); } else { $fileMd5s[] = md5_file($currEntry); } } } $d->close(); return md5(implode('', $fileMd5s)); } /* * * @param string $file * @param string $backup * * @return bool * * @throws LSCMException Thrown indirectly by Logger::debug() call. * @throws LSCMException Thrown indirectly by Logger::debug() call. / private static function matchFileSettings( $file, $backup ) { clearstatcache(); $ownerID = fileowner($file); $groupID = filegroup($file); if ( $ownerID === false \|\| $groupID === false ) { Logger::debug("Could not get owner/group of file $file"); unlink($backup); Logger::debug("Removed file $backup"); return false; } self::changeUserGroup($backup, $ownerID, $groupID); self::matchPermissions($file, $backup); return true; } /* * * @param string $filepath * @param string $bak * * @return string / private static function getBackupSuffix( $filepath, $bak = '_lscachebak_orig' ) { $i = 1; if ( file_exists($filepath . $bak) ) { $bak = sprintf("_lscachebak_%02d", $i); while ( file_exists($filepath . $bak) ) { $i++; $bak = sprintf("_lscachebak_%02d", $i); } } return $bak; } /* * * @param string $filepath * * @return bool * * @throws LSCMException Thrown indirectly by Logger::debug() call. * @throws LSCMException Thrown indirectly by Logger::verbose() call. * @throws LSCMException Thrown indirectly by self::matchFileSettings() * call. * @throws LSCMException Thrown indirectly by Logger::debug() call. * @throws LSCMException Thrown indirectly by Logger::debug() call. * @throws LSCMException Thrown indirectly by Logger::info() call. / public static function createBackup( $filepath ) { $backup = $filepath . self::getBackupSuffix($filepath); if ( !copy($filepath, $backup) ) { Logger::debug( "Could not backup file $filepath to location $backup" ); return false; } Logger::verbose("Created file $backup"); if ( !self::matchFileSettings($filepath, $backup) ) { Logger::debug( "Could not backup file $filepath to location $backup" ); return false; } Logger::debug('Matched owner/group setting for both files'); Logger::info( "Successfully backed up file $filepath to location $backup" ); return true; } /* * * @param string $zipFile * @param string $dest * * @return bool * * @throws LSCMException Thrown indirectly by Logger::debug() call. * @throws LSCMException Thrown indirectly by Logger::debug() call. / public static function unzipFile( $zipFile, $dest ) { if ( class_exists('\ZipArchive') ) { $zipArchive = new ZipArchive(); if ( $zipArchive->open($zipFile) === true ) { $extracted = $zipArchive->extractTo($dest); $zipArchive->close(); if ( $extracted ) { return true; } } Logger::debug("Could not unzip $zipFile using ZipArchive."); } $output = array(); exec( "unzip $zipFile -d $dest > /dev/null 2>&1", $output, $return_var ); if ( $return_var == 0 ) { return true; } else { Logger::debug("Could not unzip $zipFile from cli."); } return false; } /* * Check if a given directory is empty. * * @param string $dir * * @return bool / public static function is_dir_empty( $dir ) { if ( !($handle = @opendir($dir)) ) { return true; } while ( ($entry = readdir($handle)) !== false ) { if ( $entry != '.' && $entry != '..' ) { return false; } } return true; } /* * * @param string $vhCacheRoot / public static function ensureVHCacheRootInCage( $vhCacheRoot ) { $cageFsFile = '/etc/cagefs/cagefs.mp'; if ( file_exists($cageFsFile) ) { if ( $vhCacheRoot[0] == '/' ) { $cageVhCacheRoot = '%' . str_replace('/$vh_user', '', $vhCacheRoot); $matchFound = preg_grep( "!^\s" . str_replace('!', '\!', $cageVhCacheRoot) . "!im", file($cageFsFile) ); if ( !$matchFound ) { file_put_contents( $cageFsFile, "\n$cageVhCacheRoot", FILE_APPEND ); exec('/usr/sbin/cagefsctl --remount-all'); } } } } /** * Recursively a directory's contents and optionally the directory itself. * * @param string $dir Directory path * @param bool $keepParent Only remove directory contents when true. * * @return bool / public static function rrmdir( $dir, $keepParent = false ) { if ( $dir != '' && is_dir($dir) ) { if ( ($matches = glob("$dir/")) === false ) { return false; } foreach ( $matches as $file ) { if ( is_dir($file) ) { self::rrmdir($file); } else { unlink($file); } } if ( !$keepParent ) { rmdir($dir); } return true; } return false; } /** * Wrapper for idn_to_utf8() function call to avoid "undefined" exceptions * when PHP intl module is not installed and enabled. * * @since 1.13.13.1 * * @param string $domain * @param int $flags * @param int\|null $variant * @param array\|null $idna_info * * @return false\|string / public static function tryIdnToUtf8( $domain, $flags = 0, $variant = null, &$idna_info = null ) { if ( empty($domain) \|\| !function_exists('idn_to_utf8') ) { return $domain; } if ( $variant == null ) { $variant = INTL_IDNA_VARIANT_UTS46; } return idn_to_utf8($domain, $flags, $variant, $idna_info); } /* * Wrapper for idn_to_ascii() function call to avoid "undefined" exceptions * when PHP intl module is not installed and enabled. * * @since 1.13.13.1 * * @param string $domain * @param int\|null $flags * @param int\|null $variant * @param array\|null $idna_info * * @return false\|string / public static function tryIdnToAscii( $domain, $flags = null, $variant = null, &$idna_info = null ) { if ( empty($domain) \|\| !function_exists('idn_to_ascii') ) { return $domain; } if ( $flags == null ) { $flags = IDNA_DEFAULT; } if ( $variant == null ) { $variant = INTL_IDNA_VARIANT_UTS46; } return idn_to_ascii($domain, $flags, $variant, $idna_info); } /* * Version comparison function capable of properly comparing versions with * trailing ".0" groups such as '6.1' which is equal to '6.1.0' which is * equal to '6.1.000.0' etc. * * @since 1.14.2 * * @param string $ver1 * @param string $ver2 * @param string\|null $operator * * @return bool\|int / public static function betterVersionCompare( $ver1, $ver2, $operator = null ) { $pattern = '/(\.0+)+($\|-)/'; return version_compare( preg_replace($pattern, '', $ver1), preg_replace($pattern, '', $ver2), $operator ); } /* * * @since 1.15.0.1 * * @param string $constantName * @param array\|bool\|float\|int\|null\|string $value * @param bool $caseInsensitive Optional * parameter used for define calls in PHP versions below 7.3. * * @return bool * * @noinspection PhpDeprecationInspection Ignore deprecation of define() * parameter $case_insensitive for PHP versions below 7.3. * @noinspection RedundantSuppression / public static function define_wrapper( $constantName, $value, $caseInsensitive = false ) { if ( PHP_VERSION_ID < 70300 ) { return define($constantName, $value, $caseInsensitive); } else { return define($constantName, $value); } } /* * * @since 1.17.1.1 * * @param int $wpStatus * * @return string[] [ stateMsg => string, link => string ] */ public static function getFatalErrorStateMessageAndLink( $wpStatus ) { $stateMsg = $anchor = ''; if ( $wpStatus & WPInstall::ST_ERR_EXECMD ) { $stateMsg = 'WordPress fatal error encountered during action ' . 'execution. This is most likely caused by custom code in ' . 'this WordPress installation.'; $anchor = '#fatal-error-encountered-during-action-execution'; } if ( $wpStatus & WPInstall::ST_ERR_EXECMD_DB ) { $stateMsg = 'Error establishing WordPress database connection.'; } elseif ( $wpStatus & WPInstall::ST_ERR_TIMEOUT ) { $stateMsg = 'Timeout occurred during action execution.'; $anchor = '#timeout-occurred-during-action-execution'; } elseif ( $wpStatus & WPInstall::ST_ERR_SITEURL ) { $stateMsg = 'Could not retrieve WordPress siteURL.'; $anchor = '#could-not-retrieve-wordpress-siteurl'; } elseif ( $wpStatus & WPInstall::ST_ERR_DOCROOT ) { $stateMsg = 'Could not match WordPress siteURL to a known ' . 'control panel docroot.'; $anchor = '#could-not-match-wordpress-siteurl-to-a-known-' . 'cpanel-docroot'; } elseif ( $wpStatus & WPInstall::ST_ERR_WPCONFIG ) { $stateMsg = 'Could not find a valid wp-config.php file.'; $anchor = '#could-not-find-a-valid-wp-configphp-file'; } $stateMsg .= ' Click for more information.'; return array( 'stateMsg' => $stateMsg, 'link' => 'https://docs.litespeedtech.com/lsws/cp/cpanel/' . "whm-litespeed-plugin/troubleshooting/$anchor" ); } }	18.15 KB	2026-03-12 22:37
📁 View	-	2026-03-12 22:37
📄 WPCaller.php <?php / ******************************************* * LiteSpeed Web Server Cache Manager * * @author Michael Alegre * @copyright 2018-2025 LiteSpeed Technologies, Inc. * ******************************************* / namespace Lsc\Wp; use Lsc\Wp\Context\Context; use Lsc\Wp\WpWrapper\PluginUpgrader; use Lsc\Wp\WpWrapper\WpConstants; use Lsc\Wp\WpWrapper\WpFuncs; use Lsc\Wp\WpWrapper\Wpdb; use Lsc\Wp\WpWrapper\WpQuery; use Lsc\Wp\WpWrapper\WpTextdomainRegistry; /* * Calls WP internal functions in SHORTINIT mode. / class WPCaller { /* * @var string / const LSCWP_PLUGIN = 'litespeed-cache/litespeed-cache.php'; /* * @var string / const LSCWP_HTTP_HOST_TEST = 'litespeed_something_is_wrong'; /* * @var null\|WPCaller / private static $instance = null; /* * @var WPInstall / private $currInstall; /* * @since 1.13.4.4 * @var string / private $advancedCacheFile; /* * @var bool / private $loadLscwp; /* * @var string / private $pluginEntry; /* * @since 1.13 * @var null\|string / private $installedLscwpVer = null; /* * @var string[] / private $outputResult = []; /* * @var string / private $massIncr = ''; /* * * @param WPInstall $curInstall * @param bool $loadLscwp * * @throws LSCMException Thrown indirectly by $this->init() call. / private function __construct( WPInstall $curInstall, $loadLscwp ) { $this->currInstall = $curInstall; $this->loadLscwp = $loadLscwp; $this->init(); } /* * * @since 1.13.4.4 * * @throws LSCMException Thrown indirectly by $this->initWp() call. / private function init() { $this->advancedCacheFile = "{$this->currInstall->getPath()}/wp-content/advanced-cache.php"; $this->initWp(); } /* * * @param WPInstall $currInstall * @param bool $loadLscwp * * @return WPCaller * * @throws LSCMException Thrown indirectly by "new self()" call. / public static function getInstance( WPInstall $currInstall, $loadLscwp = true ) { if ( self::$instance == null \|\| self::$instance->currInstall !== $currInstall ) { self::$instance = new self($currInstall, $loadLscwp); } return self::$instance; } /* * * @param int $errno Not used at this time. * @param string $errstr * * @return bool * * @noinspection PhpUnusedParameterInspection / public static function warning_handler( $errno, $errstr ) { if ( in_array( $errstr, [ 'ini_set() has been disabled for security reasons', 'Constant FS_METHOD already defined' ] ) ) { /* * Throw this warning out. / return true; } return false; } /* * Deprecated 03/12/19 as this function is no longer used. * * Prevents database table options not in the $allowedOptions list * from having their value updated by others during execution. * * Run when WP function apply_filters('pre_update_option', ...) is called * in WP function update_option(). * * @deprecated * * @param mixed $value New option value. * @param string $option Option name in db. * @param mixed $old_value Old option value. * * @return mixed / public static function lock_database( $value, $option, $old_value ) { if ( in_array( $option, [ 'litespeed-cache-conf', '_transient_lscwp_whm_install', 'active_plugins', '_transient_doing_cron', '_site_transient_update_plugins', 'uninstall_plugins' ] ) ) { return $value; } return $old_value; } /* * Redefine disabled PHP global/core functions that no longer exist * (PHP 8+). * * @since 1.13.10 / private static function redefineDisabledFunctions() { if ( Util::betterVersionCompare(phpversion(), '8.0', '>=') ) { include_once(__DIR__ . '/RedefineGlobalFuncs.php'); } } /* * * @return string[] / public function getOutputResult() { return $this->outputResult; } /* * Adds key value pair to $this->outputResult to be grabbed later in * the $output variable of the UserCommand::issue() exec call. * * @param string $key * @param mixed $value / private function outputResult( $key, $value ) { $this->outputResult[$key] = $value; } /* * * @deprecated 1.9 Use Logger::getLogMsgQueue() to get these messages as * LogEntry objects. * * @return string[] * * @throws LSCMException Thrown indirectly by Logger::getLogMsgQueue() * call. / public function getDebugMsgs() { $debugMsgs = []; foreach ( Logger::getLogMsgQueue() as $logEntry ) { $label = Logger::getLvlDescr($logEntry->getLvl()); $debugMsgs[] = "[$label] {$logEntry->getMsg()}"; } return $debugMsgs; } /* * @deprecated 1.9 Deprecated 07/30/19. Use * Logger::getUiMsgs(Logger::UI_ERR) to get these messages. * * @return string[] * * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. / public function getErrMsgs() { return Logger::getUiMsgs(Logger::UI_ERR); } /* * * @deprecated 1.9 Deprecated 07/30/19. Use * Logger::getUiMsgs(Logger::UI_SUCC) to get these messages. * * @return string[] * * @throws LSCMException Thrown indirectly by Logger::getUiMsgs() call. / public function getSuccMsgs() { return Logger::getUiMsgs(Logger::UI_SUCC); } /* * * WP Variables $table_prefix * * @global string $table_prefix * * @return string / private function getSiteURL() { global $table_prefix; $siteURL = WpFuncs::getOption('siteurl'); if ( !$siteURL ) { return ''; } if ( strpos($siteURL, self::LSCWP_HTTP_HOST_TEST) !== false ) { /* * User is setting WP_SITEURL using fake $_SERVER['HTTP_HOST']. * Get siteurl value from DB directly. / return WpFuncs::getVar( "SELECT option_value FROM {$table_prefix}options " . "WHERE option_name = 'siteurl'" ); } return $siteURL; } /* * * @since 1.17.0.3 * * @param string $advCacheFileContents * * @return bool / private static function advancedCacheFileBelongsToLscwp( $advCacheFileContents ) { return ( self::advancedCacheFileHasLscacheDefine($advCacheFileContents) \|\| self::advancedCacheFileHasPlaceholderMsg($advCacheFileContents) ); } /* * * @since 1.13.4.3 * * @return bool / private function generic3rdPartyAdvCachePluginExists() { if ( Util::betterVersionCompare( $this->installedLscwpVer, '3.0.4', '>=' ) ) { if ( file_exists($this->advancedCacheFile) ) { $advCacheFileContents = file_get_contents($this->advancedCacheFile); if ( $advCacheFileContents !== '' ) { /* * Old LSCWP advanced-cache.php file is no longer used in * these versions but is also never cleaned up. As a result, * any existing advanced-cache.php files need to have their * contents checked to avoid detecting an old LSCWP * advanced-cache.php file as a generic 3rd-party * advanced-cache plugin. / return !self::advancedCacheFileBelongsToLscwp( $advCacheFileContents ); } } } elseif ( !defined('LSCACHE_ADV_CACHE') \|\| WpConstants::getWpConstant('LSCACHE_ADV_CACHE') !== true ) { return true; } return false; } /* * * @since 1.13.8 Added optional parameter $output. * * @param WPInstall $install * @param bool $output * * @return int * * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by $install->addUserFlagFile() * call. * @throws LSCMException Thrown indirectly by $install->addUserFlagFile() * call. * @throws LSCMException Thrown indirectly by Logger::notice() call. * @throws LSCMException Thrown indirectly by Logger::notice() call. / private function checkStatus( WPInstall $install, $output = false ) { if ( $output ) { if ( ($siteUrl = $this->getSiteURL()) === '' ) { Logger::uiError( 'Could not retrieve siteURL to match against known ' . 'docroots.' ); $install->addUserFlagFile(); return (WPInstall::ST_ERR_SITEURL \| WPInstall::ST_FLAGGED); } $this->outputResult('SITEURL', $siteUrl); } $status = 0; /* * Check if plugin files exist first, as status in db could be stale if * LSCWP was removed manually. / if ( file_exists($this->pluginEntry) && WpFuncs::isPluginActive(self::LSCWP_PLUGIN) ) { $status \|= WPInstall::ST_PLUGIN_ACTIVE; //TODO: Get rid of ST_LSC_ADVCACHE_DEFINED status or replace with // new "is caching enabled" define check. if ( $this->generic3rdPartyAdvCachePluginExists() ) { $status \|= WPInstall::ST_FLAGGED; } else { $status \|= WPInstall::ST_LSC_ADVCACHE_DEFINED; } } else { $status \|= WPInstall::ST_PLUGIN_INACTIVE; } if ( $install->hasFlagFile() ) { $status \|= WPInstall::ST_FLAGGED; } if ( $status & WPInstall::ST_FLAGGED ) { Logger::notice( 'Install is ' . (($install->addUserFlagFile()) ? '' : 'not ') . 'flagged' ); } return $status; } /* * * @param bool $output * * @return int * * @throws LSCMException Thrown indirectly by $this->checkStatus() call. / public function updateStatus( $output = false ) { $status = $this->checkStatus($this->currInstall, $output); $this->currInstall->setStatus($status); if ( $output ) { $this->outputResult('STATUS', $status); } if ( $status & WPInstall::ST_ERR_SITEURL ) { return UserCommand::EXIT_FAIL; } return UserCommand::EXIT_SUCC; } /* * * @return int * * @throws LSCMException Thrown indirectly by $this->updateStatus() call. / private function getCurrStatus() { $this->updateStatus(); return $this->currInstall->getStatus(); } /* * Check if any known cache plugins that do not use an advanced-cache.php * file are active for this WordPress installation. If any of these plugins * are found, that plugin's slug is returned. * * @since 1.9.1 * * @return string Empty string or detected active cache plugin slug. / private function checkForKnownNonAdvCachePlugins() { /* * Only one plugin at the moment. / $slug = 'wp-fastest-cache'; $plugin = 'wp-fastest-cache/wpFastestCache.php'; /* * Check if plugin files exist first, as status in db could be * stale if plugin files were removed manually. / if ( file_exists( WpConstants::getWpConstant('WP_PLUGIN_DIR') . "/$plugin" ) && WpFuncs::isPluginActive($plugin) ) { return $slug; } return ''; } /* * * @param bool $isMassAction * @param bool $isNewInstall * * @return bool * * @throws LSCMException Thrown indirectly by $this->getCurrStatus() call. * @throws LSCMException Thrown indirectly by * $this->currInstall->addUserFlagFile() call. * @throws LSCMException Thrown indirectly by Logger::uiSuccess() call. * @throws LSCMException Thrown indirectly by Logger::notice() call. * @throws LSCMException Thrown indirectly by * $this->currInstall->addUserFlagFile() call. * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by Logger::notice() call. * @throws LSCMException Thrown indirectly by Logger::uiSuccess() call. * @throws LSCMException Thrown indirectly by Logger::notice() call. * @throws LSCMException Thrown indirectly by * $this->currInstall->addUserFlagFile() call. * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by Logger::notice() call. / private function canEnable( $isMassAction, $isNewInstall ) { $status = $this->getCurrStatus(); if ( $status & WPInstall::ST_PLUGIN_INACTIVE ) { if ( !$isNewInstall && $isMassAction ) { $this->currInstall->addUserFlagFile(); Logger::uiSuccess( 'LSCWP Detected As Manually Disabled - Flag Set' ); Logger::notice( 'Ignore - Previously disabled, flag it from mass operation' ); return false; } $thirdPartyCachePluginSlug = $this->checkForKnownNonAdvCachePlugins(); if ( $thirdPartyCachePluginSlug != '' ) { $this->currInstall->addUserFlagFile(); Logger::uiError( 'Cannot Enable LSCWP - Detected another active cache ' . "plugin \"$thirdPartyCachePluginSlug\". Flag set." ); Logger::notice( 'Ignore - Detected another active cache plugin ' . "\"$thirdPartyCachePluginSlug\". Flagged." ); return false; } } elseif ( !$isNewInstall ) { /* * already active / if ( $status & WPInstall::ST_LSC_ADVCACHE_DEFINED ) { Logger::uiSuccess('LSCWP Already Enabled - No Action Taken'); Logger::notice('Ignore - Already enabled'); } else { $this->currInstall->addUserFlagFile(); Logger::uiError( 'LSCWP Already Enabled But Not Caching - Detected another ' . 'active cache plugin. Please visit the WordPress ' . 'Dashboard for further instructions.' ); Logger::notice( 'Ignore - Existing install but advanced cache not set' ); } return false; } return true; } /* * * @return int * * @throws LSCMException Thrown indirectly by $this->canEnable() call. * @throws LSCMException Thrown indirectly by $this->enable_lscwp() call. * @throws LSCMException Thrown indirectly by * $this->directEnableNewInstall() call. / public function directEnable() { $isNewInstall = !file_exists($this->pluginEntry); if ( !$this->canEnable(false, $isNewInstall) ) { $this->outputResult('STATUS', $this->currInstall->getStatus()); return UserCommand::EXIT_FAIL; } $this->outputResult( 'STATUS', ( ($isNewInstall) ? $this->directEnableNewInstall() : $this->enable_lscwp() ) ); return UserCommand::EXIT_SUCC; } /* * * @return int * * @throws LSCMException Thrown when unable to extract downloaded LSCWP * files. * @throws LSCMException Thrown indirectly by $this->downloadLSCWPZip() * call. * @throws LSCMException Thrown indirectly by $this->enable_lscwp() call. * @throws LSCMException Thrown indirectly by * $this->removeLscwpPluginFiles() call. / private function directEnableNewInstall() { $pluginDir = WpConstants::getWpConstant('WP_PLUGIN_DIR'); $lscwpZip = "$pluginDir/litespeed-cache.latest-stable.zip"; $this->downloadLSCWPZip($lscwpZip); WpFuncs::WpFilesystem(); $unzipRet = WpFuncs::unzipFile($lscwpZip, $pluginDir); unlink($lscwpZip); if ( $unzipRet !== true ) { throw new LSCMException( 'Unable to extract downloaded LSCWP files.', LSCMException::E_NON_FATAL ); } $this->currInstall->addNewLscwpFlagFile(); PluginVersion::tryCopyLscwpDefaultConf($pluginDir); $this->installedLscwpVer = $this->getPluginVersionFromFile(); $status = $this->enable_lscwp(); if ( $status & WPInstall::ST_PLUGIN_INACTIVE) { $this->removeLscwpPluginFiles(); } else { $this->updateTranslationFiles(); } return $status; } /* * * @param string $lscwpZip * * @return null * * @throws LSCMException Thrown when LSCWP download operation fails. / private function downloadLscwpZip( $lscwpZip ) { $pluginDir = WpConstants::getWpConstant('WP_PLUGIN_DIR'); $url = 'https://downloads.wordpress.org/plugin/' . 'litespeed-cache.latest-stable.zip'; exec( "wget -q --tries=1 --no-check-certificate $url -P $pluginDir", $output1, $return_var1 ); if ( $return_var1 === 0 && file_exists($lscwpZip) ) { return; } /* * Fall back to curl in case wget is disabled for user. / exec( "cd $pluginDir && curl -O -s --retry 1 --insecure $url", $output2, $return_var2 ); if ( $return_var2 === 0 && file_exists($lscwpZip) ) { return; } throw new LSCMException( "Failed to download LSCWP with wget exit status $return_var1 and " . "curl exit status $return_var2.", LSCMException::E_NON_FATAL ); } /* * * @param array $extraArgs Not used at this time. * @param bool $massOp True when called from massEnable(). * * @return int * * @throws LSCMException Thrown indirectly by PluginVersion::getInstance() * call. * @throws LSCMException Thrown indirectly by * PluginVersion::getInstance()->prepareUserInstall() call. * @throws LSCMException Thrown indirectly by $this->canEnable() call. * @throws LSCMException Thrown indirectly by $this->enable_lscwp() call. * @throws LSCMException Thrown indirectly by * $this->removeLscwpPluginFiles() call. * * @noinspection PhpUnusedParameterInspection / public function enable( array $extraArgs, $massOp = false ) { $isNewInstall = PluginVersion::getInstance()->prepareUserInstall( WpConstants::getWpConstant('WP_PLUGIN_DIR') ); if ( $isNewInstall ) { $this->installedLscwpVer = $this->getPluginVersionFromFile(); $this->currInstall->addNewLscwpFlagFile(); } if ( !$this->canEnable($massOp, $isNewInstall) ) { $status = $this->currInstall->getStatus(); $ret = UserCommand::EXIT_FAIL; } else { $status = $this->enable_lscwp(); $ret = UserCommand::EXIT_SUCC; } if ( $isNewInstall ) { if ( $status & WPInstall::ST_PLUGIN_INACTIVE ) { $this->removeLscwpPluginFiles(); } else { $this->updateTranslationFiles(); } } $this->outputResult('STATUS', $this->currInstall->getStatus()); return $ret; } /* * * @param string[] $extraArgs * * @return int * * @throws LSCMException Thrown indirectly by $this->enable() call. / public function massEnable( array $extraArgs ) { $ret = $this->enable($extraArgs, true); if ( $this->massIncr != '' ) { $this->outputResult('MASS_INCR', $this->massIncr); } return $ret; } /* * * @param bool $isMassAction * * @return bool * * @throws LSCMException Thrown indirectly by $this->getCurrStatus() call. * @throws LSCMException Thrown indirectly by Logger::notice() call. * @throws LSCMException Thrown indirectly by Logger::uiSuccess() call. * @throws LSCMException Thrown indirectly by * $this->currInstall->addUserFlagFile() call. * @throws LSCMException Thrown indirectly by Logger::uiSuccess() call. * @throws LSCMException Thrown indirectly by Logger::notice() call. * @throws LSCMException Thrown indirectly by * $this->currInstall->addUserFlagFile() call. * @throws LSCMException Thrown indirectly by Logger::uiSuccess() call. / private function canDisable( $isMassAction ) { $status = $this->getCurrStatus(); if ( $status & WPInstall::ST_PLUGIN_INACTIVE ) { Logger::notice('Ignore - Already disabled'); Logger::uiSuccess( 'LiteSpeed Cache Already Disabled - No Action Taken' ); return false; } if ( $isMassAction ) { if ( !($status & WPInstall::ST_LSC_ADVCACHE_DEFINED) ) { $this->currInstall->addUserFlagFile(); Logger::uiSuccess( 'LSCWP Detected As Manually Enabled But Not Caching - Flag ' . 'Set. If desired, this installation can be disabled ' . 'from the Manage Cache Installations screen.' ); Logger::notice( 'Ignore for mass disable - Installed manually as advanced ' . 'cache not set.' ); return false; } if ( WpFuncs::isPluginActiveForNetwork(self::LSCWP_PLUGIN) ) { $this->currInstall->addUserFlagFile(); Logger::uiSuccess( 'LiteSpeed Cache Detected As Network Activated - Flag Set ' . '& No Action Taken' ); return false; } } return true; } /* * * @param string[] $extraArgs Not used at this time. * @param bool $massOp True when called from MassDisable(). * * @return int * * @throws LSCMException Thrown indirectly by $this->canDisable() call. * @throws LSCMException Thrown indirectly by $this->performDisable() call. * @throws LSCMException Thrown indirectly by Logger::uiSuccess() call. * * @noinspection PhpUnusedParameterInspection / public function disable( array $extraArgs, $massOp = false ) { if ( !$this->canDisable($massOp) ) { $ret = UserCommand::EXIT_FAIL; } else { if ( $this->performDisable(true) & WPInstall::ST_PLUGIN_ACTIVE ) { $ret = UserCommand::EXIT_FAIL; } else { Logger::uiSuccess('LiteSpeed Cache Disabled'); $this->massIncr = 'SUCC'; $ret = UserCommand::EXIT_SUCC; } } $this->outputResult('STATUS', $this->currInstall->getStatus()); return $ret; } /* * * @param string[] $extraArgs * * @return int * * @throws LSCMException Thrown indirectly by $this->disable() call. / public function massDisable( array $extraArgs ) { $ret = $this->disable($extraArgs, true); if ( $this->massIncr != '' ) { $this->outputResult('MASS_INCR', $this->massIncr); } return $ret; } /* * Includes LSCWP files needed to properly disable the LSCWP plugin. * * @since 1.13 Removed param $lscwpVer. / private function includeDisableRequiredFiles() { $dir = WpConstants::getWpConstant('WP_PLUGIN_DIR') . '/litespeed-cache'; switch (true) { case Util::betterVersionCompare( $this->installedLscwpVer, '3.0', '>=' ): require_once "$dir/src/admin.cls.php"; break; case Util::betterVersionCompare( $this->installedLscwpVer, '1.1.2.2', '>' ): require_once "$dir/admin/litespeed-cache-admin.class.php"; break; default: require_once "$dir/admin/class-litespeed-cache-admin.php"; } if ( Util::betterVersionCompare( $this->installedLscwpVer, '1.1.0', '<' ) && Util::betterVersionCompare( $this->installedLscwpVer, '1.0.6', '>' ) ) { require_once "$dir/admin/class-litespeed-cache-admin-rules.php"; } } /* * * @param bool $uninstall * * @return int * * @throws LSCMException Thrown indirectly by $this->disable_lscwp() call. / private function performDisable( $uninstall ) { $this->includeDisableRequiredFiles(); return $this->disable_lscwp($uninstall); } /* * * @param string[] $fromVersions * @param string $toVersion * @param bool $massOp Not used at this time. * * @return bool * * @noinspection PhpUnusedParameterInspection / private function canUpgrade( array $fromVersions, $toVersion, $massOp ) { if ( !file_exists($this->pluginEntry) \|\| $toVersion == $this->installedLscwpVer ) { return false; } foreach ( $fromVersions as $fromVer ) { $fromVerParts = explode('.', $fromVer); $installedVerParts = explode('.', $this->installedLscwpVer); $i = 0; while ( isset($fromVerParts[$i]) ) { $fromVerPart = $fromVerParts[$i]; if ( $fromVerPart == 'x' ) { return true; } if ( !isset($installedVerParts[$i]) \|\| $installedVerParts[$i] != $fromVerPart ) { continue 2; } $i++; } if ( !isset($installedVerParts[$i]) ) { return true; } } return false; } /* * * @param string[] $extraArgs * @param bool $massOp * * @return int * * @throws LSCMException Thrown indirectly by $this->updateStatus() call. * @throws LSCMException Thrown indirectly by $this->upgrade_lscwp() call. / public function upgrade( array $extraArgs, $massOp = false ) { $toVersion = $extraArgs[1]; if ( !$this->canUpgrade( explode(',', $extraArgs[0]), $toVersion, $massOp ) ) { $this->updateStatus(true); return UserCommand::EXIT_FAIL; } $this->upgrade_lscwp($toVersion); return UserCommand::EXIT_SUCC; } /* * * @param string[] $extraArgs * * @return int * * @throws LSCMException Thrown indirectly by $this->upgrade() call. / public function massUpgrade( array $extraArgs ) { $ret = $this->upgrade($extraArgs, true); if ( $this->massIncr != '' ) { $this->outputResult('MASS_INCR', $this->massIncr); } return $ret; } /* * * @param bool $uninstall / private function deactivate_lscwp( $uninstall ) { WpFuncs::deactivatePlugins(self::LSCWP_PLUGIN); if ( $uninstall ) { //Todo: add some msg about having removed plugin files? WpFuncs::deletePlugins([ self::LSCWP_PLUGIN ]); } } /* * @since 1.17.5 * * @return array / private function getWpdBlogIds() { return Wpdb::getCol('SELECT blog_id FROM ' . Wpdb::getBlogs() . ';'); } /* * * @param bool $uninstall * * @return int * * @throws LSCMException Thrown indirectly by $this->getCurrStatus() call. / private function disable_lscwp( $uninstall ) { if ( WpConstants::getWpConstant('MULTISITE') ) { foreach ( $this->getWpdBlogIds() as $blogId ) { WpFuncs::switchToBlog($blogId); $this->deactivate_lscwp($uninstall); WpFuncs::restoreCurrentBlog(); } } else { $this->deactivate_lscwp($uninstall); } return $this->getCurrStatus(); } /* * * @return int * * @throws LSCMException Thrown indirectly by $this->getCurrStatus() call. * @throws LSCMException Thrown indirectly by $this->performDisable() call. * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by * $this->currInstall->addUserFlagFile() call. * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by Logger::uiSuccess() call. / private function enable_lscwp() { /* * Should not check directly, can error on success due to object cache. / WpFuncs::activatePlugin(self::LSCWP_PLUGIN); $status = $this->getCurrStatus(); switch (true) { case !($status & WPInstall::ST_LSC_ADVCACHE_DEFINED): $status = $this->performDisable(true); Logger::uiError( 'Detected ' . "{$this->currInstall->getPath()}/wp-content/" . 'advanced-cache.php as belonging to another cache ' . 'plugin. Please deactivate the related cache plugin ' . 'and try again. You may also try manually installing ' . 'through the WordPress Dashboard and following the ' . 'instructions given.' ); $this->massIncr = 'FAIL'; break; case ($status & WPInstall::ST_PLUGIN_ACTIVE): if ( !is_writable($this->currInstall->getWpConfigFile()) && ( !defined('WP_CACHE') \|\| WpConstants::getWpConstant('WP_CACHE') !== true ) ) { /* * LSCACHE_ADV_CACHE is incorrectly defined true at this point. * Detected status must be manually corrected. / $status &= ~WPInstall::ST_LSC_ADVCACHE_DEFINED; $this->currInstall->setStatus($status); $this->currInstall->addUserFlagFile(); $status = $this->currInstall->getStatus(); Logger::uiError( 'LSCWP Enabled But Not Caching - Please visit the ' . 'WordPress Dashboard for further instructions.' ); } else { Logger::uiSuccess('LSCWP Enabled'); } $this->massIncr = 'SUCC'; break; } return $status; } /* * * @param string $ver * @param bool $runHooks * * @throws LSCMException Thrown when LSCWP plugin version upgrade fails. / private function upgrade_lscwp( $ver, $runHooks = true ) { /* * Label the following $upgraderWrapper output (Cannot be buffered). / echo "[UPGRADE]\n"; $upgraderWrapper = new PluginUpgrader; $upgraderWrapper->init(); $upgraderWrapper->upgradeStrings(); if ( $runHooks ) { WpFuncs::addFilter( 'upgrader_pre_install', [ $upgraderWrapper->getWpPluginUpgraderObject(), 'deactivate_plugin_before_upgrade' ], 10, 2 ); WpFuncs::addFilter( 'upgrader_clear_destination', [ $upgraderWrapper->getWpPluginUpgraderObject(), 'delete_old_plugin' ], 10, 4 ); } $upgraderWrapper->run( [ 'package' => 'https://downloads.wordpress.org/plugin/' . "litespeed-cache.$ver.zip", 'destination' => WpConstants::getWpConstant('WP_PLUGIN_DIR'), 'clear_destination' => true, 'clear_working' => true, 'hook_extra' => [ 'plugin' => $this->pluginEntry, 'type' => 'plugin', 'action' => 'update' ] ] ); /* * Start new messages on a new line / echo "\n"; if ( $runHooks ) { /* * Cleanup our hooks, in case something else does an upgrade on * this connection. / WpFuncs::removeFilter( 'upgrader_pre_install', [ $upgraderWrapper->getWpPluginUpgraderObject(), 'deactivate_plugin_before_upgrade' ] ); WpFuncs::removeFilter( 'upgrader_clear_destination', [ $upgraderWrapper->getWpPluginUpgraderObject(), 'delete_old_plugin' ] ); } if ( !$upgraderWrapper->getResult() \|\| WpFuncs::isWpError($upgraderWrapper->getResult()) ) { throw new LSCMException( "Failed to upgrade to v$ver.", LSCMException::E_NON_FATAL ); } $this->updateTranslationFiles(); /* * Force refresh of plugin update information / WpFuncs::wpCleanPluginsCache(); } /* * Gets LSCWP version from the litespeed-cache.php file. * * @return string / private function getPluginVersionFromFile() { $lscwp_data = WpFuncs::getPluginData($this->pluginEntry, false, false); return $lscwp_data['Version']; } /* * Checks for local plugin translation files and copies them to the plugin * languages directory if able. This function will also attempt to inform * the root user when a locale's translation should be retrieved or removed. / public function updateTranslationFiles() { $locale = WpFuncs::getLocale(); if ( $locale == 'en_US' ) { return; } $langDir = $this->currInstall->getPath() . '/wp-content/languages/plugins'; if ( !file_exists($langDir) ) { mkdir($langDir, 0755); } $localTranslationDir = Context::LOCAL_PLUGIN_DIR . "/$this->installedLscwpVer/translations"; $moFileName = "litespeed-cache-$locale.mo"; $poFileName = "litespeed-cache-$locale.po"; $localMoFile = "$localTranslationDir/$moFileName"; $localPoFile = "$localTranslationDir/$poFileName"; $zipFile = "$localTranslationDir/$locale.zip"; $translationFlag = "$localTranslationDir/" . PluginVersion::TRANSLATION_CHECK_FLAG_BASE . "_$locale"; if ( file_exists($localMoFile) && file_exists($localPoFile) ) { copy($localMoFile, "$langDir/$moFileName"); copy($localPoFile, "$langDir/$poFileName"); } elseif ( file_exists($zipFile) ) { WpFuncs::WpFilesystem(); if ( WpFuncs::unzipFile($zipFile, $langDir) !== true ) { $this->outputResult( 'BAD_TRANSLATION', "$locale $this->installedLscwpVer" ); } } elseif ( !file_exists($translationFlag) \|\| (time() - filemtime($translationFlag)) > 86400 ) { $this->outputResult( 'GET_TRANSLATION', "$locale $this->installedLscwpVer" ); } } /* * * @since 1.13.4.4 * @since 1.17.0.3 Added required parameter $advCacheFileContents. * * @param string $advCacheFileContents * * @return bool / private static function advancedCacheFileHasLscacheDefine( $advCacheFileContents ) { return (strpos($advCacheFileContents, 'LSCACHE_ADV_CACHE') !== false); } /* * Check if advanced-cache.php file contains LSCWP placeholder text. This * file with generic placeholder text was re-added by LSCWP for improved * compatibility with WordPress versions lower than v5.3. * * @since 1.17.0.3 * * @param string $advCacheFileContent * * @return bool / private static function advancedCacheFileHasPlaceholderMsg( $advCacheFileContent ) { return ( strpos( $advCacheFileContent, 'A compatibility placeholder for WordPress < v5.3' ) !== false ); } private function includeLSCWPAdvancedCacheFile() { if ( file_exists($this->advancedCacheFile) ) { $advCacheFileContents = file_get_contents($this->advancedCacheFile); if ( $advCacheFileContents !== '' && $this->advancedCacheFileHasLscacheDefine( $advCacheFileContents ) ) { include_once $this->advancedCacheFile; } } } /* * * @throws LSCMException Thrown indirectly by * $this->currInstall->removePluginFiles() call. / public function removeLscwpPluginFiles() { $this->currInstall->removePluginFiles(dirname($this->pluginEntry)); } /* * * @param string[] $extraArgs * @param bool $massOp Not used at this time. * * @return int * * @throws LSCMException Thrown indirectly by * DashNotifier::prepareUserInstall() call. * @throws LSCMException Thrown indirectly by DashNotifier::doNotify() * call. * @throws LSCMException Thrown indirectly by Logger::uiSuccess() call. * @throws LSCMException Thrown indirectly by Logger::uiError() call. * * @noinspection PhpUnusedParameterInspection / public function dashNotify( array $extraArgs, $massOp = false ) { if ( DashNotifier::canNotify($this->currInstall->getPath()) ) { DashNotifier::prepareUserInstall(); if ( DashNotifier::doNotify(base64_decode($extraArgs[0])) ) { Logger::uiSuccess('Notified Successfully'); $this->massIncr = 'SUCC'; return UserCommand::EXIT_SUCC; } Logger::uiError('Failed to Notify'); $this->massIncr = 'FAIL'; } else { $this->massIncr = 'BYPASS'; } return UserCommand::EXIT_FAIL; } /* * * @param string[] $extraArgs * * @return int * * @throws LSCMException Thrown indirectly by $this->dashNotify() call. / public function massDashNotify( array $extraArgs ) { $ret = $this->dashNotify($extraArgs, true); if ( $this->massIncr != '' ) { $this->outputResult('MASS_INCR', $this->massIncr); } return $ret; } /* * * @param string[] $extraArgs Unused for now. * @param bool $massOp Unused for now. * * @return int * * @throws LSCMException Thrown indirectly by Logger::uiSuccess() call. * * @noinspection PhpUnusedParameterInspection / public function dashDisable( array $extraArgs, $massOp = false ) { if ( WpConstants::getWpConstant('MULTISITE') ) { foreach ( $this->getWpdBlogIds() as $blogId ) { WpFuncs::switchToBlog($blogId); DashNotifier::deactivate(true); WpFuncs::restoreCurrentBlog(); } } else { DashNotifier::deactivate(true); } if ( WpFuncs::isPluginActive(DashNotifier::DASH_PLUGIN) ) { $this->massIncr = 'FAIL'; return UserCommand::EXIT_FAIL; } Logger::uiSuccess('Dash Notifier Disabled'); $this->massIncr = 'SUCC'; return UserCommand::EXIT_SUCC; } /* * * @param string[] $extraArgs * * @return int * * @throws LSCMException Thrown indirectly by $this->dashDisable() call. / public function massDashDisable( array $extraArgs ) { $ret = $this->dashDisable($extraArgs, true); if ( $this->massIncr != '' ) { $this->outputResult('MASS_INCR', $this->massIncr); } return $ret; } /* * * @since 1.12 * * @param bool $setOutputResult * * @return string / public function getQuicCloudAPIKey( $setOutputResult = false ) { $key = WpFuncs::applyFilters('litespeed_conf', 'api_key', null); if ( $key == 'api_key' \|\| $key == null ) { $key = ''; } if ( $setOutputResult ) { $this->outputResult('API_KEY', $key); } return $key; } /* * Set global server and environment variables. * * @since 1.9.8 * * @param string $key * @param mixed $val / private function setEnvVar( $key, $val ) { $_SERVER[$key] = $val; putenv("$key=$val"); } /* * Checks if the current WordPress installation is a multisite install and * does some preload setup if so. * * Patterns and multisite check logic based on WordPress function * is_multisite(). * * @since 1.9.8 * * @return bool * * @throws LSCMException Thrown when DOMAIN_CURRENT_SITE is not found with * MULTISITE defined. * @throws LSCMException Thrown when PATH_CURRENT_SITE is not found with * MULTISITE defined. / private function isMultisite() { $config_content = file_get_contents($this->currInstall->getWpConfigFile()); $isMultiSite = ( preg_match( '/define$\s[\'"]MULTISITE[\'"]\s,[^;];/', $config_content, $m1 ) && preg_match( '/define\(\s[\'"]MULTISITE[\'"]\s,\strue\s$\s;/', $m1[0] ) ) \|\| ( preg_match( '/define$\s[\'"]SUBDOMAIN_INSTALL[\'"]\s,[^;];/', $config_content ) \|\| preg_match( '/define\(\s[\'"]VHOST[\'"]\s,[^;];/', $config_content ) \|\| preg_match( '/define\(\s[\'"]SUNRISE[\'"]\s,[^;];/', $config_content ) ); if ( !$isMultiSite ) { return false; } if ( !preg_match( '/define\(\s[\'"]DOMAIN_CURRENT_SITE[\'"]\s,' . '\s[\'"](.+)[\'"]\s$\s;/', $config_content, $m2 ) ) { throw new LSCMException( 'Cannot find DOMAIN_CURRENT_SITE with MULTISITE defined.' ); } $this->currInstall->setServerName($m2[1]); if ( !preg_match( '/define$\s[\'"]PATH_CURRENT_SITE[\'"]\s,' . '\s[\'"](.+)[\'"]\s$\s;/', $config_content, $m3 ) ) { throw new LSCMException( 'Cannot find PATH_CURRENT_SITE with MULTISITE defined.' ); } $this->setEnvVar('REQUEST_URI', $m3[1]); Util::define_wrapper('WP_NETWORK_ADMIN', true); return true; } /** * * WP Variables: $wpdb, $shortcode_tags * * @global \wpdb $wpdb * @global array $shortcode_tags * * @throws LSCMException Thrown when detected WordPress version is lower * then 4.0. * @throws LSCMException Thrown when unable to find a required WordPress * include file. * @throws LSCMException Thrown indirectly by $this->isMultisite() call. * * @noinspection PhpUndefinedClassInspection / private function initWp() { /* * Declared global variables for use in included files. * * @noinspection PhpUnusedLocalVariableInspection / global $wpdb, $shortcode_tags; error_reporting(E_ALL); /* * Attempt to override any WordPress memory limits. / Util::define_wrapper('WP_MEMORY_LIMIT', '512M'); Util::define_wrapper('WP_MAX_MEMORY_LIMIT', '512M'); /* * Only load core WordPress functionality. / Util::define_wrapper('SHORTINIT', true); $wpPath = $this->currInstall->getPath(); /* * Set WP version data global variables, including $wp_version. / include_once "$wpPath/wp-includes/version.php"; /* @noinspection PhpUndefinedVariableInspection $wp_version is defined * and made available in previous version.php include / if ( Util::betterVersionCompare($wp_version, '4.0', '<') ) { throw new LSCMException( "Detected WordPress version as $wp_version. Version 4.0 ' . 'required at minimum." ); } /* * Set needed server variables. / $_SERVER['SCRIPT_FILENAME'] = "$wpPath/wp-admin/plugins.php"; if ( !$this->isMultisite() ) { $this->setEnvVar('REQUEST_URI', ''); } /* * Set for LSCWP v1.1.5.1+ plugin logic. / if ( $docRoot = $this->currInstall->getDocRoot() ) { /* * For enable/disable. / $this->setEnvVar('DOCUMENT_ROOT', $docRoot); } $serverName = $this->currInstall->getServerName(); if ( empty($serverName) ) { $serverName = self::LSCWP_HTTP_HOST_TEST; } /* * For security plugins. / $this->setEnvVar('HTTP_HOST', $serverName); /* * Version specific includes may fail on RC releases. / $includeFiles = [ '/wp-load.php', '/wp-includes/default-constants.php', '/wp-includes/formatting.php', '/wp-includes/meta.php', '/wp-includes/l10n.php', '/wp-includes/class-wp-walker.php', '/wp-includes/capabilities.php' ]; if ( Util::betterVersionCompare($wp_version, '4.4.0', '>=') ) { $includeFiles[] = '/wp-includes/class-wp-roles.php'; $includeFiles[] = '/wp-includes/class-wp-role.php'; $includeFiles[] = '/wp-includes/class-wp-user.php'; $includeFiles[] = '/wp-includes/rest-api.php'; $includeFiles[] = '/wp-includes/class-wp-http-encoding.php'; $includeFiles[] = '/wp-includes/class-wp-http-proxy.php'; $includeFiles[] = '/wp-includes/class-wp-http-response.php'; $includeFiles[] = '/wp-includes/class-wp-http-curl.php'; $includeFiles[] = '/wp-includes/class-wp-http-cookie.php'; } $includeFiles[] = '/wp-includes/query.php'; $includeFiles[] = '/wp-includes/theme.php'; $includeFiles[] = '/wp-includes/class-wp-theme.php'; $includeFiles[] = '/wp-includes/user.php'; $includeFiles[] = '/wp-includes/general-template.php'; $includeFiles[] = '/wp-includes/link-template.php'; $includeFiles[] = '/wp-includes/post.php'; $includeFiles[] = '/wp-includes/kses.php'; $includeFiles[] = '/wp-includes/cron.php'; $includeFiles[] = '/wp-includes/update.php'; $includeFiles[] = '/wp-includes/shortcodes.php'; $includeFiles[] = '/wp-includes/http.php'; if ( Util::betterVersionCompare($wp_version, '5.9.0', '>=') ) { $includeFiles[] = '/wp-includes/class-wp-http.php'; } else { $includeFiles[] = '/wp-includes/class-http.php'; } if ( Util::betterVersionCompare($wp_version, '4.6.0', '>=') ) { $includeFiles[] = '/wp-includes/class-wp-http-requests-response.php'; } if ( Util::betterVersionCompare($wp_version, '4.7.0', '>=') ) { $includeFiles[] = '/wp-includes/class-wp-http-requests-hooks.php'; /* * Content contained in /wp-includes/query.php for earlier versions. / $includeFiles[] = '/wp-includes/class-wp-query.php'; } if ( Util::betterVersionCompare($wp_version, '5.0.0', '>=') ) { $includeFiles[] = '/wp-includes/blocks.php'; $includeFiles[] = '/wp-includes/class-wp-block-parser.php'; } if ( Util::betterVersionCompare($wp_version, '6.1.0', '>=') ) { $includeFiles[] = '/wp-includes/class-wp-textdomain-registry.php'; } $includeFiles[] = '/wp-includes/ms-functions.php'; $includeFiles[] = '/wp-includes/ms-deprecated.php'; $includeFiles[] = '/wp-includes/pluggable.php'; $includeFiles[] = '/wp-admin/includes/plugin.php'; $includeFiles[] = '/wp-admin/includes/file.php'; $includeFiles[] = '/wp-admin/includes/class-wp-upgrader.php'; $includeFiles[] = '/wp-admin/includes/misc.php'; $includeFiles[] = '/wp-admin/includes/template.php'; if ( Util::betterVersionCompare($wp_version, '6.5.0', '>=') ) { $includeFiles[] = '/wp-includes/class-wp-plugin-dependencies.php'; } set_error_handler('\Lsc\Wp\WPCaller::warning_handler'); /* * Force WP to use PHP I/O file handling. / Util::define_wrapper('FS_METHOD', 'direct'); /* * Trigger an early return from WP Rocket advanced-cache.php to prevent * WP Rocket from serving a cached copy and killing the process. This * occurs when calling an action from our control panel plugins and is * fixed by more closely matching the environment of a direct cli call. / unset($_SERVER['REQUEST_METHOD']); self::redefineDisabledFunctions(); foreach ( $includeFiles as $relFilePath ) { $file = $wpPath . $relFilePath; if ( !file_exists($file) ) { throw new LSCMException( "Could not include missing file $file." ); } include_once $file; } restore_error_handler(); /* * Needs to be defined after including files. / Util::define_wrapper('WP_ADMIN', true); /* * Define common WP constants and set 'wp_plugin_paths' array. / WpFuncs::wpPluginDirectoryConstants(); /* * Do not load other plugins. / $GLOBALS['wp_plugin_paths'] = []; WpFuncs::wpCookieConstants(); /* * Create global wp_query (WordPress) object entry. Needed during * LSCWP uninstall. */ $GLOBALS['wp_the_query'] = (new WpQuery())->getWpWpQueryObject(); $GLOBALS['wp_query'] = $GLOBALS['wp_the_query']; if ( Util::betterVersionCompare($wp_version, '6.1.0', '>=') ) { $GLOBALS['wp_textdomain_registry'] = (new WpTextdomainRegistry())->getWpWpTextdomainRegistryObject(); } $this->pluginEntry = WpConstants::getWpConstant('WP_PLUGIN_DIR') . '/' . self::LSCWP_PLUGIN ; if ( $this->loadLscwp && file_exists($this->pluginEntry) ) { include $this->pluginEntry; $this->installedLscwpVer = $this->getPluginVersionFromFile(); if ( Util::betterVersionCompare( $this->installedLscwpVer, '3.0.4', '<' ) ) { $this->includeLSCWPAdvancedCacheFile(); } } } }	54.41 KB	2026-03-12 22:37
📄 WPDashMsgs.php <?php / ******************************************* * LiteSpeed Web Server WordPress Dash Notifier * * @author Michael Alegre * @copyright 2019-2023 LiteSpeed Technologies, Inc. * ******************************************* / namespace Lsc\Wp; class WPDashMsgs { /* * @var string / const MSG_TYPE_RAP = 'rap'; /* * @var string / const MSG_TYPE_BAM = 'bam'; /* * @var string / const KEY_RAP_MSGS = 'rapMsgs'; /* * @var string / const KEY_BAM_MSGS = 'bamMsgs'; /* * Do not change the following constant values, substr 'msg' is used in * PanelController to determine action. / /* * @var string / const ACTION_GET_MSG = 'msgGet'; /* * @var string / const ACTION_ADD_MSG = 'msgAdd'; /* * @var string / const ACTION_DELETE_MSG = 'msgDelete'; /* * @var string / protected $dataFile; /* * @var string[][] / protected $msgData = array(); public function __construct( ) { $this->dataFile = realpath(__DIR__ . '/../../..') . '/admin/lscdata/wpDashMsgs.data'; $this->init(); } protected function init() { if ( file_exists($this->dataFile) ) { $data = json_decode(file_get_contents($this->dataFile), true); if ( $data && is_array($data) ) { $this->msgData = $data; } } if ( !isset($this->msgData[self::KEY_RAP_MSGS]) ) { $this->msgData[self::KEY_RAP_MSGS] = array(); } if ( !isset($this->msgData[self::KEY_BAM_MSGS]) ) { $this->msgData[self::KEY_BAM_MSGS] = array(); } /* * Set default rap message and plugin slug. / $this->msgData[self::KEY_RAP_MSGS] = array_merge( array( 'default' => array( 'msg' => 'Greetings! This is your hosting company ' . 'encouraging you to click the button to install the ' . 'LiteSpeed Cache plugin. This plugin will speed up ' . 'your WordPress site dramatically. Please contact us ' . 'with any questions.', 'slug' => 'litespeed-cache' ) ), $this->msgData[self::KEY_RAP_MSGS] ); } /* * * @param string $type * * @return string[]\|string[][] / public function getMsgData( $type = '' ) { switch ($type) { case self::MSG_TYPE_RAP: return $this->msgData[self::KEY_RAP_MSGS]; case self::MSG_TYPE_BAM: return $this->msgData[self::KEY_BAM_MSGS]; default: return $this->msgData; } } /* * * @param string $type * @param string $msgId * @param string $msg * @param string $slug * * @return bool / public function addMsg( $type, $msgId, $msg, $slug = '' ) { if ( $msgId === '' \|\| $msgId === NULL \|\| ($msgId == 'default' && $type == self::MSG_TYPE_RAP) \|\| strlen($msgId) > 50 \|\| preg_match('/[^a-zA-Z0-9_-]/', $msgId) ) { return false; } switch ($type) { case self::MSG_TYPE_RAP: $this->msgData[self::KEY_RAP_MSGS][$msgId] = array( 'msg' => $msg, 'slug' => $slug ); break; case self::MSG_TYPE_BAM: $this->msgData[self::KEY_BAM_MSGS][$msgId] = array( 'msg' => $msg ); break; default: return false; } $this->saveDataFile(); return true; } /* * * @param string $type * @param string $msgId * * @return bool */ public function deleteMsg( $type, $msgId ) { if ( $msgId === '' \|\| $msgId === NULL ) { return false; } switch ($type) { case self::MSG_TYPE_RAP: if ( $msgId == 'default' ) { return false; } $key = self::KEY_RAP_MSGS; break; case self::MSG_TYPE_BAM: $key = self::KEY_BAM_MSGS; break; default: return false; } if ( isset($this->msgData[$key][$msgId]) ) { unset($this->msgData[$key][$msgId]); $this->saveDataFile(); return true; } return false; } protected function saveDataFile() { file_put_contents($this->dataFile, json_encode($this->msgData)); } }	4.75 KB	2026-03-12 22:37
📄 WPInstall.php <?php / ******************************************* * LiteSpeed Web Server Cache Manager * * @author LiteSpeed Technologies, Inc. (https://www.litespeedtech.com) * @copyright (c) 2018-2025 * ******************************************* / namespace Lsc\Wp; use Lsc\Wp\Panel\ControlPanel; use Lsc\Wp\Context\Context; class WPInstall { /* * @var int / const ST_PLUGIN_ACTIVE = 1; /* * @var int / const ST_PLUGIN_INACTIVE = 2; /* * @var int / const ST_LSC_ADVCACHE_DEFINED = 4; /* * @var int / const ST_FLAGGED = 8; /* * @var int / const ST_ERR_SITEURL = 16; /* * @var int / const ST_ERR_DOCROOT = 32; /* * @var int / const ST_ERR_EXECMD = 64; /* * @var int / const ST_ERR_TIMEOUT = 128; /* * @var int / const ST_ERR_EXECMD_DB = 256; /* * @var int / const ST_ERR_WPCONFIG = 1024; /* * @var int / const ST_ERR_REMOVE = 2048; /* * @var string / const FLD_STATUS = 'status'; /* * @var string / const FLD_DOCROOT = 'docroot'; /* * @var string / const FLD_SERVERNAME = 'server_name'; /* * @var string / const FLD_SITEURL = 'site_url'; /* * @var string / const FLAG_FILE = '.litespeed_flag'; /* * @var string / const FLAG_NEW_LSCWP = '.lscm_new_lscwp'; /* * @var string / protected $path; /* * @var array / protected $data; /* * @var null\|string / protected $phpBinary = null; /* * @var null\|string / protected $suCmd = null; /* * @var null\|array Keys are 'user_id', 'user_name', 'group_id' / protected $ownerInfo = null; /* * @var bool / protected $changed = false; /* * @var bool / protected $refreshed = false; /* * @var null\|string / protected $wpConfigFile = ''; /* * @var int / protected $cmdStatus = 0; /* * @var string / protected $cmdMsg = ''; /* * * @param string $path / public function __construct( $path ) { $this->init($path); } /* * * @param string $path / protected function init( $path ) { if ( ($realPath = realpath($path)) === false ) { $this->path = $path; } else { $this->path = $realPath; } $this->data = array( self::FLD_STATUS => 0, self::FLD_DOCROOT => null, self::FLD_SERVERNAME => null, self::FLD_SITEURL => null ); } /* * * @return string / public function __toString() { if ( $this->data[self::FLD_SITEURL] ) { $siteUrl = Util::tryIdnToUtf8($this->data[self::FLD_SITEURL]); } else { $siteUrl = ''; } return sprintf( "%s (status=%d docroot=%s siteurl=%s)", $this->path, $this->data[self::FLD_STATUS], $this->data[self::FLD_DOCROOT], $siteUrl ); } /* * * @return string\|null / public function getDocRoot() { return $this->getData(self::FLD_DOCROOT); } /* * * @param string $docRoot * * @return bool / public function setDocRoot( $docRoot ) { return $this->setData(self::FLD_DOCROOT, $docRoot); } /* * * @return string\|null / public function getServerName() { return $this->getData(self::FLD_SERVERNAME); } /* * * @param string $serverName * * @return bool / public function setServerName( $serverName ) { return $this->setData( self::FLD_SERVERNAME, Util::tryIdnToAscii((string)$serverName) ); } /* * Note: Temporary function name until existing deprecated setSiteUrl() * function is removed. * * @param string $siteUrl * * @return bool / public function setSiteUrlDirect( $siteUrl ) { return $this->setData( self::FLD_SITEURL, Util::tryIdnToAscii((string)$siteUrl) ); } /* * * @param int $status * * @return bool / public function setStatus( $status ) { return $this->setData(self::FLD_STATUS, $status); } /* * * @return int / public function getStatus() { return $this->getData(self::FLD_STATUS); } /* * * @param string $field * * @return mixed\|null / public function getData( $field = '' ) { if ( !$field ) { return $this->data; } if ( isset($this->data[$field]) ) { return $this->data[$field]; } /* * Error out / return null; } /* * * @param string $field * @param mixed $value * * @return bool / protected function setData( $field, $value ) { if ( $this->data[$field] !== $value ) { $this->changed = true; $this->data[$field] = $value; return true; } return false; } /* * Calling from unserialized data. * * @param array $data / public function initData( array $data ) { $this->data = $data; } /* * * @return string / public function getPath() { return $this->path; } /* * * @return bool / public function shouldRemove() { return (bool)(($this->getStatus() & self::ST_ERR_REMOVE)); } /* * * @return bool / public function hasFlagFile() { return file_exists("$this->path/" . self::FLAG_FILE); } /* * * @return bool / public function hasNewLscwpFlagFile() { return file_exists("$this->path/" . self::FLAG_NEW_LSCWP); } /* * * @return bool * * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by Logger::notice() call. * @throws LSCMException Thrown indirectly by $this->addUserFlagFile() * call. * @throws LSCMException Thrown indirectly by Logger::uiError() call. * @throws LSCMException Thrown indirectly by Logger::error() call. / public function hasValidPath() { if ( !is_dir($this->path) \|\| !is_dir("$this->path/wp-admin") ) { $this->setStatusBit(self::ST_ERR_REMOVE); $msg = "$this->path - Could not be found and has been removed from " . 'Cache Manager list.'; Logger::uiError($msg); Logger::notice($msg); return false; } if ( $this->getWpConfigFile() == null ) { $this->setStatusBit(self::ST_ERR_WPCONFIG); $this->addUserFlagFile(false); $msg = "$this->path - Could not find a valid wp-config.php file. " . 'Install has been flagged.'; Logger::uiError($msg); Logger::error($msg); return false; } return true; } /* * Set the provided status bit. * * @param int $bit / public function setStatusBit( $bit ) { $this->setStatus(($this->getStatus() \| $bit)); } /* * Unset the provided status bit. * * @param int $bit / public function unsetStatusBit( $bit ) { $this->setStatus(($this->getStatus() & ~$bit )); } /* * * @deprecated 1.9.5 Deprecated to avoid confusion with $this->cmdStatus * and $this->cmdMsg related functions. Use $this->setStatus() instead. * * @param int $newStatus / public function updateCommandStatus( $newStatus ) { $this->setData(self::FLD_STATUS, $newStatus); } /* * * @return null\|string / public function getWpConfigFile() { if ( $this->wpConfigFile === '' ) { $file = "$this->path/wp-config.php"; if ( !file_exists($file) ) { /* * check parent dir / $parentDir = dirname($this->path); $file = "$parentDir/wp-config.php"; if ( !file_exists($file) \|\| file_exists("$parentDir/wp-settings.php") ) { /* * If wp-config moved up, in same dir should NOT have * wp-settings / $file = null; } } $this->wpConfigFile = $file; } return $this->wpConfigFile; } /* * Takes a WordPress site URL and uses it to populate serverName, siteUrl, * and docRoot data. If a matching docRoot cannot be found using the * serverName, the installation will be flagged and an ST_ERR_DOCROOT status * set. * * @param string $url * * @return bool * * @throws LSCMException Thrown indirectly by * ControlPanel::getClassInstance() call. * @throws LSCMException Thrown indirectly by * ControlPanel::getClassInstance()->mapDocRoot() call. * @throws LSCMException Thrown indirectly by $this->addUserFlagFile() * call. * @throws LSCMException Thrown indirectly by Logger::error() call. / public function populateDataFromUrl( $url ) { /* @noinspection HttpUrlsUsage / $parseSafeUrl = (preg_match('#^https?://#', $url)) ? $url : "http://$url"; $info = parse_url($parseSafeUrl); $serverName = Util::tryIdnToAscii((string)$info['host']); $this->setData(self::FLD_SERVERNAME, $serverName); $siteUrlTrim = $serverName; if ( isset($info['path']) ) { $siteUrlTrim .= $info['path']; } $this->setData(self::FLD_SITEURL, $siteUrlTrim); $docRoot = ControlPanel::getClassInstance()->mapDocRoot($serverName); $this->setData(self::FLD_DOCROOT, $docRoot); if ( $docRoot === null ) { $this->setStatus(self::ST_ERR_DOCROOT); $this->addUserFlagFile(false); $msg = "$this->path - Could not find matching document root for " . "WP siteurl/servername $serverName."; $this->setCmdStatusAndMsg(UserCommand::EXIT_ERROR, $msg); Logger::error($msg); return false; } return true; } /* * Deprecated 06/18/19. Renamed to populateDataFromUrl(). * * @deprecated * * @param string $siteUrl * * @return bool * * @throws LSCMException Thrown indirectly by $this->populateDataFromUrl() * call. / public function setSiteUrl( $siteUrl ) { return $this->populateDataFromUrl($siteUrl); } /* * Adds the flag file to an installation. * * @param bool $runningAsUser * * @return bool True when install has a flag file created/already. * * @throws LSCMException Thrown when unlink() call on preexisting flag file * fails. * @throws LSCMException Thrown indirectly by Context::getFlagFileContent() * call. / public function addUserFlagFile( $runningAsUser = true ) { $flagFile = "$this->path/" . self::FLAG_FILE; if ( file_exists($flagFile) ) { /* Do not trust existing flag file / if ( !unlink($flagFile) ) { throw new LSCMException( 'Failed to remove preexisting untrusted flag file.' ); } } if ( !file_put_contents($flagFile, Context::getFlagFileContent()) ) { return false; } if ( !$runningAsUser ) { $ownerInfo = $this->getOwnerInfo(); chown($flagFile, $ownerInfo['user_id']); chgrp($flagFile, $ownerInfo['group_id']); } $this->setStatusBit(self::ST_FLAGGED); return true; } /* * * @return bool / public function removeFlagFile() { $flagFile = "$this->path/" . self::FLAG_FILE; if ( file_exists($flagFile) ) { if ( !unlink($flagFile) ) { return false; } } $this->unsetStatusBit(self::ST_FLAGGED); return true; } /* * Add a flag file to indicate that a new LSCWP plugin was added to this * installation. * * This function should only be called by the installation owner to avoid * permission problems involving this file. * * @return bool / public function addNewLscwpFlagFile() { $file = "$this->path/" . self::FLAG_NEW_LSCWP; if ( !file_exists($file) ) { if ( !file_put_contents($file, '') ) { return false; } } return true; } /* * Remove "In Progress" flag file to indicate that a WPInstall action has * been completed. * * @return bool / public function removeNewLscwpFlagFile() { $file = "$this->path/" . self::FLAG_NEW_LSCWP; if ( file_exists($file) ) { if ( !unlink($file) ) { return false; } } return true; } /* * * @param bool $forced * * @return int * * @throws LSCMException Thrown indirectly by UserCommand::issue() call. / public function refreshStatus( $forced = false ) { if ( !$this->refreshed \|\| $forced ) { UserCommand::issue(UserCommand::CMD_STATUS, $this); $this->refreshed = true; } return $this->getData(self::FLD_STATUS); } /* * * @param string $pluginDir * * @throws LSCMException Thrown indirectly by Logger::debug() call. / public function removePluginFiles( $pluginDir ) { if ( file_exists(dirname($pluginDir)) && file_exists($pluginDir) ) { exec("rm -rf $pluginDir"); Logger::debug( "$this->path - Removed LSCache for WordPress plugin files from " . 'plugins directory' ); } } /* * * @return bool / public function isFlagBitSet() { if ( ($this->getStatus() & self::ST_FLAGGED) ) { return true; } return false; } /* * * @param null\|int $status * * @return bool / public function hasFatalError( $status = null ) { if ( $status === null ) { $status = $this->getData(self::FLD_STATUS); } $errMask = ( self::ST_ERR_EXECMD \| self::ST_ERR_EXECMD_DB \| self::ST_ERR_TIMEOUT \| self::ST_ERR_SITEURL \| self::ST_ERR_DOCROOT \| self::ST_ERR_WPCONFIG ); return (($status & $errMask) > 0); } /* * * @return string * * @throws LSCMException Thrown indirectly by * ControlPanel::getClassInstance() call. * @throws LSCMException Thrown indirectly by * ControlPanel::getClassInstance()->getPhpBinary() call. / public function getPhpBinary() { if ( $this->phpBinary == null ) { $this->phpBinary = ControlPanel::getClassInstance()->getPhpBinary($this); } return $this->phpBinary; } /* * Returns requested owner info. * * @param string $field Key ('user_id', 'user_name', or 'group_id') in the * $ownerInfo array. * * @return array\|int\|string\|null / public function getOwnerInfo( $field = '' ) { if ( $this->ownerInfo == null ) { $this->ownerInfo = Util::populateOwnerInfo($this->path); } if ( $field == '' ) { return $this->ownerInfo; } elseif ( isset($this->ownerInfo[$field]) ) { return $this->ownerInfo[$field]; } return null; } /* * * @return string / public function getSuCmd() { if ( $this->suCmd == null ) { $this->suCmd = "su {$this->getOwnerInfo('user_name')} -s /bin/bash"; } return $this->suCmd; } /* * * @return int / public function getCmdStatus() { return $this->cmdStatus; } /* * * @return string */ public function getCmdMsg() { return $this->cmdMsg; } public function setCmdStatusAndMsg( $status, $msg ) { $this->cmdStatus = $status; $this->cmdMsg = $msg; } }	16.81 KB	2026-03-12 22:37
📄 WPInstallStorage.php <?php / ******************************************* * LiteSpeed Web Server Cache Manager * * @author Michael Alegre * @copyright 2018-2025 LiteSpeed Technologies, Inc. * ******************************************* / namespace Lsc\Wp; use Lsc\Wp\Context\Context; use Lsc\Wp\Panel\ControlPanel; use Lsc\Wp\ThirdParty\Polyfill\Utf8; /* * map to data file / class WPInstallStorage { /* * @var string / const CMD_ADD_CUST_WPINSTALLS = 'addCustWPInstalls'; /* * @since 1.13.3 * @var string / const CMD_ADD_NEW_WPINSTALL = 'addNewWPInstall'; /* * @deprecated 1.13.3 Use CMD_DISCOVER_NEW2 instead. * @var string / const CMD_DISCOVER_NEW = 'discoverNew'; /* * @since 1.14 * @var string / const CMD_DISCOVER_NEW_AND_ENABLE = 'discoverNewAndEnable'; /* * @since 1.13.3 * @var string / const CMD_DISCOVER_NEW2 = 'discoverNew2'; /* * @var string / const CMD_FLAG = 'flag'; /* * @var string / const CMD_MASS_FLAG = 'mass_flag'; /* * @var string / const CMD_MASS_UNFLAG = 'mass_unflag'; /* * @deprecated 1.13.3 Use CMD_SCAN2 instead for now. * @var string / const CMD_SCAN = 'scan'; /* * @since 1.13.3 * @var string / const CMD_SCAN2 = 'scan2'; /* * @var string / const CMD_UNFLAG = 'unflag'; /* * @var string / const DATA_VERSION = '1.5'; /* * @var int / const ERR_NOT_EXIST = 1; /* * @var int / const ERR_CORRUPTED = 2; /* * @var int / const ERR_VERSION_HIGH = 3; /* * @var int / const ERR_VERSION_LOW = 4; /* * @var string / protected $dataFile; /* * @var string / protected $customDataFile; /* * @var null\|WPInstall[] Key is the path to a WordPress installation. / protected $wpInstalls = null; /* * @var null\|WPInstall[] Key is the path to a WordPress installation. / protected $custWpInstalls = null; /* * @var int / protected $error; /* * @var WPInstall[] / protected $workingQueue = []; /* * * @param string $dataFile * @param string $custDataFile * * @throws LSCMException Thrown indirectly by $this->init() call. / public function __construct( $dataFile, $custDataFile = '' ) { $this->dataFile = $dataFile; $this->customDataFile = $custDataFile; $this->error = $this->init(); } /* * * @return int * * @throws LSCMException Thrown indirectly by Logger::debug() call. / protected function init() { $dataExists = false; try { if ( file_exists($this->dataFile) ) { $dataExists = true; $this->wpInstalls = $this->getDataFileData($this->dataFile); } if ( $this->customDataFile != '' && file_exists($this->customDataFile) ) { $dataExists = true; $this->custWpInstalls = $this->getDataFileData($this->customDataFile); } } catch ( LSCMException $e ) { Logger::debug($e->getMessage()); return $e->getCode(); } if ( !$dataExists ) { return self::ERR_NOT_EXIST; } return 0; } /* * * @since 1.15 * * @param string $dataFile * * @return false\|string / protected static function getDataFileContents( $dataFile ) { return file_get_contents($dataFile); } /* * * @param string $dataFile * * @return WPInstall[] * * @throws LSCMException Thrown when data file is corrupt. * @throws LSCMException Thrown when there is a data file version issue. * @throws LSCMException Thrown indirectly by $this->verifyDataFileVer() * call. / protected function getDataFileData( $dataFile ) { $content = static::getDataFileContents($dataFile); if ( ($data = json_decode($content, true)) === null ) { /* * Data file may be in old serialized format. Try unserializing. / $data = unserialize($content); } if ( $data === false \|\| !is_array($data) \|\| !isset($data['__VER__']) ) { throw new LSCMException( "$dataFile - Data is corrupt.", self::ERR_CORRUPTED ); } if ( ($err = $this->verifyDataFileVer($dataFile, $data['__VER__'])) ) { throw new LSCMException( "$dataFile - Data file version issue.", $err ); } unset($data['__VER__']); $wpInstalls = []; foreach ( $data as $utf8Path => $idata ) { $path = Utf8::decode($utf8Path); $i = new WPInstall($path); $idata[WPInstall::FLD_SITEURL] = urldecode((string)$idata[WPInstall::FLD_SITEURL]); $idata[WPInstall::FLD_SERVERNAME] = urldecode((string)$idata[WPInstall::FLD_SERVERNAME]); $i->initData($idata); $wpInstalls[$path] = $i; } return $wpInstalls; } /* * * @return int / public function getError() { return $this->error; } /* * * @param bool $nonFatalOnly * * @return int / public function getCount( $nonFatalOnly = false ) { $count = 0; if ( $this->wpInstalls != null ) { if ( $nonFatalOnly ) { foreach ( $this->wpInstalls as $install ) { if ( !$install->hasFatalError() ) { $count++; } } } else { $count += count($this->wpInstalls); } } if ( $this->custWpInstalls != null ) { if ( $nonFatalOnly ) { foreach ( $this->custWpInstalls as $custInstall ) { if ( !$custInstall->hasFatalError() ) { $count++; } } } else { $count += count($this->custWpInstalls); } } return $count; } /* * * @return null\|WPInstall[] * * @noinspection PhpUnused / public function getWPInstalls() { return $this->wpInstalls; } /* * * @return null\|WPInstall[] * * @noinspection PhpUnused / public function getCustWPInstalls() { return $this->custWpInstalls; } /* * * @return null\|WPInstall[] / public function getAllWPInstalls() { if ( $this->wpInstalls != null ) { if ( $this->custWpInstalls != null ) { return array_merge($this->wpInstalls, $this->custWpInstalls); } else { return $this->wpInstalls; } } elseif ( $this->custWpInstalls != null ) { return $this->custWpInstalls; } else { return null; } } /* * Get all known WPInstall paths. * * @return string[] / public function getPaths() { $paths = []; if ( $this->wpInstalls != null ) { $paths = array_keys($this->wpInstalls); } if ( $this->custWpInstalls != null ) { $paths = array_merge($paths, array_keys($this->custWpInstalls)); } return $paths; } /* * * @param string $path * * @return WPInstall\|null / public function getWPInstall( $path ) { if ( ($realPath = realpath($path)) === false ) { $index = $path; } else { $index = $realPath; } if ( isset($this->wpInstalls[$index]) ) { return $this->wpInstalls[$index]; } elseif ( isset($this->custWpInstalls[$index]) ) { return $this->custWpInstalls[$index]; } return null; } /* * * @return WPInstall[] / public function getWorkingQueue() { return $this->workingQueue; } /* * * @param WPInstall $wpInstall / public function addWPInstall( WPInstall $wpInstall ) { $this->wpInstalls[$wpInstall->getPath()] = $wpInstall; } /* * * @throws LSCMException Thrown indirectly by $this->saveDataFile() call. * @throws LSCMException Thrown indirectly by $this->saveDataFile() call. / public function syncToDisk() { $this->saveDataFile($this->dataFile, $this->wpInstalls); if ( $this->customDataFile != '' ) { $this->saveDataFile($this->customDataFile, $this->custWpInstalls); } } /* * * @param string $dataFile * @param WPInstall[]\|null $wpInstalls * * @throws LSCMException Thrown indirectly by $this->log() call. / protected function saveDataFile( $dataFile, $wpInstalls ) { $data = [ '__VER__' => self::DATA_VERSION ]; if ( !empty($wpInstalls) ) { foreach ( $wpInstalls as $path => $install ) { if ( !$install->shouldRemove() ) { $utf8Path = Utf8::encode($path); $data[$utf8Path] = $install->getData(); $siteUrl = &$data[$utf8Path][WPInstall::FLD_SITEURL]; if ( $siteUrl != null ) { $siteUrl = urlencode($siteUrl); } $serverName = &$data[$utf8Path][WPInstall::FLD_SERVERNAME]; if ( $serverName != null ) { $serverName = urlencode($serverName); } } } ksort($data); } file_put_contents($dataFile, json_encode($data), LOCK_EX); chmod($dataFile, 0600); $this->log("Data file saved $dataFile", Logger::L_DEBUG); } /* * * @param string $dataFile * @param string $dataFileVer * * @return int * * @throws LSCMException Thrown indirectly by Logger::info() call. * @throws LSCMException Thrown indirectly by $this->updateDataFile() call. / protected function verifyDataFileVer( $dataFile, $dataFileVer ) { $res = Util::betterVersionCompare($dataFileVer, self::DATA_VERSION); if ( $res == 1 ) { Logger::info( 'Data file version is higher than expected and cannot be used.' ); return self::ERR_VERSION_HIGH; } if ( $res == -1 && !$this->updateDataFile($dataFile, $dataFileVer) ) { return self::ERR_VERSION_LOW; } return 0; } /* * * @param string $dataFile * @param string $dataFileVer * * @return bool * * @throws LSCMException Thrown indirectly by Logger::info() call. * @throws LSCMException Thrown indirectly by Util::createBackup() call. * @throws LSCMException Thrown indirectly by Logger::error() call. / public static function updateDataFile( $dataFile, $dataFileVer ) { Logger::info( "$dataFile - Old data file version detected. Attempting to " . 'update...' ); /* * Currently no versions are upgradeable to 1.5 / $updatableVersions = []; if ( !in_array($dataFileVer, $updatableVersions) \|\| ! Util::createBackup($dataFile) ) { Logger::error( "$dataFile - Data file could not be updated to version " . self::DATA_VERSION ); return false; } /* * Upgrade funcs will be called here. / return true; } /* * * @param string $action * * @return string[] * * @throws LSCMException Thrown when "get docroots" command fails. * @throws LSCMException Thrown when $action value is unsupported. / protected function prepareActionItems( $action ) { switch ( $action ) { case self::CMD_SCAN: case self::CMD_SCAN2: case self::CMD_DISCOVER_NEW: case self::CMD_DISCOVER_NEW2: try { return ControlPanel::getClassInstance()->getDocRoots(); } catch ( LSCMException $e ) { throw new LSCMException( $e->getMessage() . " Could not prepare $action action items." ); } case UserCommand::CMD_MASS_ENABLE: case UserCommand::CMD_MASS_DISABLE: case UserCommand::CMD_MASS_UPGRADE: case UserCommand::CMD_MASS_DASH_NOTIFY: case UserCommand::CMD_MASS_DASH_DISABLE: case self::CMD_MASS_UNFLAG: return $this->getPaths(); default: throw new LSCMException('Missing parameter(s).'); } } /* * * @param string $action * @param string $path * @param string[] $extraArgs * * @throws LSCMException Thrown when an invalid LSCWP version is selected * in action UserCommand::CMD_MASS_UPGRADE. * @throws LSCMException Thrown when LSCWP version fails to download in * action UserCommand::CMD_MASS_UPGRADE. * @throws LSCMException Thrown when LSCWP source package is not available * in action UserCommand::CMD_MASS_UPGRADE. * @throws LSCMException Thrown indirectly by $wpInstall->hasValidPath() * call. * @throws LSCMException Thrown indirectly by $wpInstall->addUserFlagFile() * call. * @throws LSCMException Thrown indirectly by $wpInstall->hasValidPath() * call. * @throws LSCMException Thrown indirectly by $wpInstall->refreshStatus() * call. * @throws LSCMException Thrown indirectly by $wpInstall->addUserFlagFile() * call. * @throws LSCMException Thrown indirectly by PluginVersion::getInstance() * call. * @throws LSCMException Thrown indirectly by * PluginVersion::getInstance()->getAllowedVersions() call. * @throws LSCMException Thrown indirectly by UserCommand::issue() call. * @throws LSCMException Thrown indirectly by $this->syncToDisk() call. * @throws LSCMException Thrown indirectly by $this->syncToDisk() call. / protected function doWPInstallAction( $action, $path, array $extraArgs ) { if ( ($wpInstall = $this->getWPInstall($path)) == null ) { $wpInstall = new WPInstall($path); $this->addWPInstall($wpInstall); } switch ( $action ) { case self::CMD_FLAG: case self::CMD_MASS_FLAG: if ( !$wpInstall->hasValidPath() ) { return; } if ( $wpInstall->addUserFlagFile(false) ) { $wpInstall->setCmdStatusAndMsg( UserCommand::EXIT_SUCC, 'Flag file set' ); } else { $wpInstall->setCmdStatusAndMsg( UserCommand::EXIT_FAIL, 'Could not create flag file' ); } $this->workingQueue[$path] = $wpInstall; return; case self::CMD_UNFLAG: case self::CMD_MASS_UNFLAG: if ( !$wpInstall->hasValidPath() ) { return; } $wpInstall->removeFlagFile(); $wpInstall->setCmdStatusAndMsg( UserCommand::EXIT_SUCC, 'Flag file unset' ); $this->workingQueue[$path] = $wpInstall; return; case UserCommand::CMD_ENABLE: case UserCommand::CMD_DISABLE: case UserCommand::CMD_DASH_NOTIFY: case UserCommand::CMD_DASH_DISABLE: if ( $wpInstall->hasFatalError() ) { $wpInstall->refreshStatus(); if ( $wpInstall->hasFatalError() ) { $wpInstall->addUserFlagFile(false); $wpInstall->setCmdStatusAndMsg( UserCommand::EXIT_FAIL, 'Install skipped and flagged due to Error status.' ); $this->workingQueue[$path] = $wpInstall; return; } } break; case UserCommand::CMD_MASS_UPGRADE: $lscwpVer = $extraArgs[1]; $isAllowedVer = in_array( $lscwpVer, PluginVersion::getInstance()->getAllowedVersions() ); if ( !$isAllowedVer ) { throw new LSCMException( 'Selected LSCWP version (' . htmlspecialchars($lscwpVer) . ') is invalid.' ); } break; //no default } if ( UserCommand::issue($action, $wpInstall, $extraArgs) ) { if ( $action == UserCommand::CMD_MASS_UPGRADE && ($wpInstall->getCmdStatus() & UserCommand::EXIT_FAIL) && preg_match( '/Download failed. Not Found/', $wpInstall->getCmdMsg() ) ) { $this->syncToDisk(); throw new LSCMException( 'Could not download version ' . htmlspecialchars($extraArgs[1]) . '.' ); } if ( $action == UserCommand::CMD_MASS_ENABLE && ($wpInstall->getCmdStatus() & UserCommand::EXIT_FAIL) && preg_match( '/Source Package not available/', $wpInstall->getCmdMsg() ) ) { $this->syncToDisk(); throw new LSCMException($wpInstall->getCmdMsg()); } $this->workingQueue[$path] = $wpInstall; } } /* * * @param string $action * @param null\|string[] $list * @param string[]\|string[][] $extraArgs * * @return string[] * * @throws LSCMException Thrown indirectly by $this->prepareActionItems() * call. * @throws LSCMException Thrown indirectly by $this->log() call. * @throws LSCMException Thrown indirectly by Context::getActionTimeout() * call. * @throws LSCMException Thrown indirectly by $this->scan() call. * @throws LSCMException Thrown indirectly by $this->addNewWPInstall() * call. * @throws LSCMException Thrown indirectly by * $this->addCustomInstallations() call. * @throws LSCMException Thrown indirectly by * PluginVersion::getCurrentVersion() call. * @throws LSCMException Thrown indirectly by PluginVersion::getInstance() * call. * @throws LSCMException Thrown indirectly by * PluginVersion::getInstance()->setActiveVersion() call. * @throws LSCMException Thrown indirectly by $this->doWPInstallAction() * call. * @throws LSCMException Thrown indirectly by $this->syncToDisk() call. / public function doAction( $action, $list, array $extraArgs = [] ) { if ( $list === null ) { $list = $this->prepareActionItems($action); } $count = count($list); $this->log("doAction $action for $count items", Logger::L_VERBOSE); $endTime = ($count > 1) ? Context::getActionTimeout() : 0; $finishedList = []; switch ( $action ) { case self::CMD_SCAN: case self::CMD_DISCOVER_NEW: foreach ( $list as $path ) { $this->scan($path, ($action == self::CMD_SCAN)); $finishedList[] = $path; if ( $endTime && time() >= $endTime ) { break; } } break; case self::CMD_ADD_NEW_WPINSTALL: foreach ( $list as $path) { $this->addNewWPInstall($path); $finishedList[] = $path; if ( $endTime && time() >= $endTime ) { break; } } break; case self::CMD_ADD_CUST_WPINSTALLS: $this->addCustomInstallations($extraArgs[0]); break; default: if ( $action == UserCommand::CMD_ENABLE \|\| $action == UserCommand::CMD_MASS_ENABLE ) { /* * Ensure that the current version is locally downloaded. / PluginVersion::getInstance() ->setActiveVersion(PluginVersion::getCurrentVersion()) ; } foreach ( $list as $path ) { $this->doWPInstallAction($action, $path, $extraArgs); $finishedList[] = $path; if ( $endTime && time() >= $endTime ) { break; } } } $this->syncToDisk(); if ( $action == self::CMD_SCAN \|\| $action == self::CMD_SCAN2 ) { /* * Explicitly clear any data file errors after scanning in case of * multiple actions performed in the same process (cli). / $this->error = 0; } return $finishedList; } /* * * @deprecated 1.13.3 Use $this->scan2() instead. * * @param string $docroot * @param bool $forceRefresh * * @return void * * @throws LSCMException Thrown indirectly by Context::getScanDepth() call. * @throws LSCMException Thrown indirectly by $this->log() call. * @throws LSCMException Thrown indirectly by $this->log() call. * @throws LSCMException Thrown indirectly by $this->log() call. * @throws LSCMException Thrown indirectly by * $this->wpInstalls[$wp_path]->refreshStatus() call. / protected function scan( $docroot, $forceRefresh = false ) { $directories = shell_exec( "find -L $docroot -maxdepth " . Context::getScanDepth() . ' -name wp-admin -print' ); $hasMatches = false; if ( $directories ) { /* * Example: * /home/user/public_html/wordpress/wp-admin * /home/user/public_html/blog/wp-admin * /home/user/public_html/wp/wp-admin / $hasMatches = preg_match_all( "\|$docroot(.)(?=/wp-admin)\|", $directories, $matches ); } if ( ! $hasMatches ) { /** * Nothing found. / return; } /* @noinspection PhpUndefinedVariableInspection / foreach ( $matches[1] as $path ) { $wp_path = realpath($docroot . $path); $refresh = $forceRefresh; if ( !isset($this->wpInstalls[$wp_path]) ) { $this->wpInstalls[$wp_path] = new WPInstall($wp_path); $refresh = true; $this->log( "New installation found: $wp_path", Logger::L_INFO ); if ( $this->custWpInstalls != null && isset($this->custWpInstalls[$wp_path]) ) { unset($this->custWpInstalls[$wp_path]); $this->log( "Installation removed from custom data file: $wp_path", Logger::L_INFO ); } } else { $this->log( "Installation already found: $wp_path", Logger::L_DEBUG ); } if ( $refresh ) { $this->wpInstalls[$wp_path]->refreshStatus(); $this->workingQueue[$wp_path] = $this->wpInstalls[$wp_path]; } } } /* * * @since 1.13.3 * @since 1.15 Changed function visibility from 'public' to * 'public static'. * * @param string $docroot * * @return string[] * * @throws LSCMException Thrown indirectly by Context::getScanDepth() call. / public static function scan2( $docroot ) { $directories = shell_exec( "find -L $docroot -maxdepth " . Context::getScanDepth() .' -name wp-admin -print' ); $hasMatches = false; if ( $directories ) { /* * Example: * /home/user/public_html/wordpress/wp-admin * /home/user/public_html/blog/wp-admin * /home/user/public_html/wp/wp-admin / $hasMatches = preg_match_all( "\|$docroot(.)(?=/wp-admin)\|", $directories, $matches ); } if ( ! $hasMatches ) { /** * Nothing found. / return []; } $wpPaths = []; /* @noinspection PhpUndefinedVariableInspection / foreach ( $matches[1] as $path ) { $wpPaths[] = realpath($docroot . $path); } return $wpPaths; } /* * Add a new WPInstall object to WPInstallStorage's $wpInstalls[] given a * path to a WordPress installation and refresh its status. If a WPInstall * object already exists for the given path, refresh its status. * * @since 1.13.3 * * @param string $wpPath * * @throws LSCMException Thrown indirectly by $this->log() call. * @throws LSCMException Thrown indirectly by $this->log() call. * @throws LSCMException Thrown indirectly by $this->log() call. * @throws LSCMException Thrown indirectly by * $this->wpInstalls[$wpPath]->refreshStatus() call. / protected function addNewWPInstall( $wpPath ) { if ( ($realPath = realpath($wpPath)) !== false ) { $wpPath = $realPath; } if ( !isset($this->wpInstalls[$wpPath]) ) { $this->wpInstalls[$wpPath] = new WPInstall($wpPath); $this->log("New installation found: $wpPath", Logger::L_INFO); if ( $this->custWpInstalls != null && isset($this->custWpInstalls[$wpPath]) ) { unset($this->custWpInstalls[$wpPath]); $this->log( "Installation removed from custom data file: $wpPath", Logger::L_INFO ); } } else { $this->log( "Installation already found: $wpPath", Logger::L_DEBUG ); } $this->wpInstalls[$wpPath]->refreshStatus(); $this->workingQueue[$wpPath] = $this->wpInstalls[$wpPath]; } /* * * @param string[] $wpInstallsInfo * * @return void * * @throws LSCMException Thrown indirectly by $this->log() call. * @throws LSCMException Thrown indirectly by $this->log() call. * @throws LSCMException Thrown indirectly by $this->log() call. * @throws LSCMException Thrown indirectly by $this->log() call. * @throws LSCMException Thrown indirectly by * $this->custWpInstalls[$wpPath]->refreshStatus() call. * @throws LSCMException Thrown indirectly by $this->log() call. * @throws LSCMException Thrown indirectly by $this->log() call. / protected function addCustomInstallations( array $wpInstallsInfo ) { if ( $this->customDataFile == '' ) { $this->log( 'No custom data file set, could not add custom Installation.', Logger::L_INFO ); return; } if ( $this->custWpInstalls == null ) { $this->custWpInstalls = []; } for ( $i = 0; $i < count($wpInstallsInfo); $i++ ) { $info = preg_split('/\s+/', trim($wpInstallsInfo[$i])); $line = $i + 1; if ( count($info) != 4 ) { $this->log( 'Incorrect number of values for custom installation input ' . "string on line $line. Skipping.", Logger::L_INFO ); continue; } $wpPath = $info[0]; if ( !file_exists("$wpPath/wp-admin") ) { $this->log( "No 'wp-admin' directory found for $wpPath on line " . "$line. Skipping.", Logger::L_INFO ); continue; } $docroot = $info[1]; if ( !(substr($wpPath, 0, strlen($docroot)) === $docroot) ) { $this->log( "docroot not contained in $wpPath on line $line. " . 'Skipping.', Logger::L_INFO ); continue; } if ( !isset($this->wpInstalls[$wpPath]) ) { $this->custWpInstalls[$wpPath] = new WPInstall($wpPath); $this->custWpInstalls[$wpPath]->setDocRoot($docroot); $this->custWpInstalls[$wpPath]->setServerName($info[2]); $this->custWpInstalls[$wpPath]->setSiteUrlDirect($info[3]); $this->custWpInstalls[$wpPath]->refreshStatus(); $this->log( "New installation added to custom data file: $wpPath", Logger::L_INFO ); } else { $this->log( "Installation already found during scan: $wpPath. " . 'Skipping.', Logger::L_INFO ); } } } /* * Get all WPInstall command messages as a key=>value array. * * @return string[][] / public function getAllCmdMsgs() { $succ = $fail = $err = []; foreach ( $this->workingQueue as $wpInstall ) { if ( ($msg = $wpInstall->getCmdMsg()) ) { $cmdStatus = $wpInstall->getCmdStatus(); switch( true ) { case $cmdStatus & UserCommand::EXIT_SUCC: $msgType = &$succ; break; case $cmdStatus & UserCommand::EXIT_FAIL: $msgType = &$fail; break; case $cmdStatus & UserCommand::EXIT_ERROR: $msgType = &$err; break; default: continue 2; } $msgType[] = "{$wpInstall->getPath()} - $msg"; } } return [ 'succ' => $succ, 'fail' => $fail, 'err' => $err ]; } /* * * @param string $msg * @param int $level * * @throws LSCMException Thrown indirectly by Logger::error() call. * @throws LSCMException Thrown indirectly by Logger::warn() call. * @throws LSCMException Thrown indirectly by Logger::notice() call. * @throws LSCMException Thrown indirectly by Logger::info() call. * @throws LSCMException Thrown indirectly by Logger::verbose() call. * @throws LSCMException Thrown indirectly by Logger::debug() call. */ protected function log( $msg, $level ) { $msg = "WPInstallStorage - $msg"; switch ( $level ) { case Logger::L_ERROR: Logger::error($msg); break; case Logger::L_WARN: Logger::warn($msg); break; case Logger::L_NOTICE: Logger::notice($msg); break; case Logger::L_INFO: Logger::info($msg); break; case Logger::L_VERBOSE: Logger::verbose($msg); break; case Logger::L_DEBUG: Logger::debug($msg); break; //no default } } }	33.24 KB	2026-03-12 22:37
📁 WpWrapper	-	2026-03-12 22:37

Edit File:

Terminal