ller files, here they are removed directly. * * @return array Removal result of each installer file, empty when the installation keeps them */ public static function finalizeCliInstall(): array { if (PHP_SAPI !== 'cli') { throw new Exception('The installation is finalized here only from the command line.'); } if (!self::isFirstLoginAfterInstallOption()) { throw new Exception('The installation is already finalized.'); } if (!self::setFinalizeUser()) { throw new Exception('No administrator can finalize the installation.'); } $migrationData = self::getMigrationData(); remove_action(self::HOOK_FIRST_LOGIN_AFTER_INSTALL, [self::class, 'autoCleanFileAfterInstall'], self::AUTO_CLEAN_PRIORITY); update_option(AdminNotices::OPTION_KEY_MIGRATION_SUCCESS_NOTICE, true); do_action(self::HOOK_FIRST_LOGIN_AFTER_INSTALL, $migrationData); if ($migrationData->cleanInstallerFiles == false) { return []; } return self::removeInstallerFiles()['files']; } /** * Remove the installer files and purge the caches, as the Tools page does after the installation; the migration * success notice goes away when every file is removed * * @return array{files:array,purge:string[]} Removal result of each file, cache purge messages */ public static function removeInstallerFiles(): array { $files = self::cleanMigrationFiles(); $purge = self::purgeCaches(); if (!in_array(false, $files, true)) { delete_option(AdminNotices::OPTION_KEY_MIGRATION_SUCCESS_NOTICE); } return [ 'files' => $files, 'purge' => $purge, ]; } /** * Set as current user the administrator the installation is finalized as: the first one who passes the first login * check, so who holds the Duplicator capability; administrators by ID, super admins on a multisite * * @return bool Whether an administrator was found */ private static function setFinalizeUser(): bool { if (is_multisite()) { $users = array_filter(array_map(fn($login) => get_user_by('login', $login), get_super_admins())); } else { $users = get_users([ 'role' => 'administrator', 'orderby' => 'ID', ]); } foreach ($users as $user) { wp_set_current_user($user->ID); if (self::isFirstLoginAfterInstall()) { return true; } } wp_set_current_user(0); return false; } /** * Admin init hook * * @return void */ public static function adminInit(): void { if (self::isFirstLoginAfterInstall()) { add_action('current_screen', [self::class, 'wpAdminHook'], 99999); update_option(AdminNotices::OPTION_KEY_MIGRATION_SUCCESS_NOTICE, true); do_action(self::HOOK_FIRST_LOGIN_AFTER_INSTALL, self::getMigrationData()); } } /** * @return void */ public static function wpAdminHook(): void { if (!ToolsPageController::isToolPage()) { wp_safe_redirect( ControllersManager::getMenuLink( ControllersManager::TOOLS_SUBMENU_SLUG, null, null, [], false ) ); exit; } } /** * check if is first login after install option is set * * @return boolean */ public static function isFirstLoginAfterInstallOption() { return get_option(self::FIRST_LOGIN_OPTION, false); } /** * Check if is first login after install * * @return boolean */ private static function isFirstLoginAfterInstall() { if (is_user_logged_in() && self::isFirstLoginAfterInstallOption()) { if (self::getMigrationData()->installType === InstState::TYPE_STANDALONE) { CapMng::getInstance()->reset(); return true; } else { CapMng::getInstance()->migrationUpdate(); return CapMng::can(CapMng::CAP_BASIC, false); } } else { return false; } } /** * Purge all caches * * @return string[] // messages */ public static function purgeCaches(): array { if (self::skipPostMigrationCacheActions()) { return []; } return CachesPurge::purgeAll(); } /** * Detected tools that hold caches requiring manual regeneration after a * domain change (no safe programmatic purge API available). * * @return array */ public static function getManualPurgeNotices(): array { if (self::skipPostMigrationCacheActions()) { return []; } return CachesPurge::getManualPurgeNotices(); } /** * @return bool true when no domain-change post-migration cache work is needed */ private static function skipPostMigrationCacheActions(): bool { return self::getMigrationData()->restoreBackupMode || in_array( self::getMigrationData()->installType, [ InstState::TYPE_SINGLE_ON_SUBDOMAIN, InstState::TYPE_SINGLE_ON_SUBFOLDER, InstState::TYPE_SUBSITE_ON_SUBDOMAIN, InstState::TYPE_SUBSITE_ON_SUBFOLDER, ] ); } /** * Update Unique identifier from migration * * @param MigrateData $migrationData migration data * * @return void */ public static function updateUniqueId(MigrateData $migrationData): void { UniqueId::getInstance()->updateFromMigration($migrationData->ustatIdentifier); } /** * Update new install info * * @param MigrateData $migrationData migration data * * @return void */ public static function updateNewInstallInfo(MigrateData $migrationData): void { if ($migrationData->restoreBackupMode || $migrationData->recoveryMode) { return; } // After migration is considered a new install UpgradePlugin::setInstallInfo(); } /** * Clean after install * * @param MigrateData $migrationData migration data * * @return void */ public static function usageStatistics(MigrateData $migrationData): void { TelemetryState::getInstance()->updateFromMigrateData($migrationData); } /** * Clean after install * * @param MigrateData $migrationData migration data * * @return void */ public static function autoCleanFileAfterInstall(MigrateData $migrationData): void { if ($migrationData->cleanInstallerFiles == false) { return; } wp_safe_redirect(ToolsPageController::getInstance()->getCleanFilesAcrtionUrl(false)); exit; } /** * Update settings after install * * @param MigrateData $migrationData migration data * * @return void */ public static function updateSettings(MigrateData $migrationData): void { $isAddSiteOnMultisite = in_array( self::getMigrationData()->installType, [ InstState::TYPE_SINGLE_ON_SUBDOMAIN, InstState::TYPE_SINGLE_ON_SUBFOLDER, InstState::TYPE_SUBSITE_ON_SUBDOMAIN, InstState::TYPE_SUBSITE_ON_SUBFOLDER, ] ); if ( !$migrationData->restoreBackupMode && !$isAddSiteOnMultisite ) { GlobalEntity::getInstance()->updateAftreInstall(); } if (!$isAddSiteOnMultisite) { do_action('duplicator_after_migration_settings_update', $migrationData); } flush_rewrite_rules(true); } /** * Update capabilities after install * * @param MigrateData $migrationData migration data * * @return void */ public static function updateCapabilities(MigrateData $migrationData): void { CapMng::getInstance()->migrationUpdate(); } /** * Return cleanup report * * @return array{removed: string[], stored: string[], instFile: string[]} */ public static function getCleanupReport() { $option = get_option(self::CLEAN_INSTALL_REPORT_OPTION); if (is_array($option)) { self::$migrationCleanupReport = array_merge(self::$migrationCleanupReport, $option); } return self::$migrationCleanupReport; } /** * Save clean up report in WordPress options * * @param MigrateData $migrationData migration data * * @return void */ public static function saveCleanupReport(MigrateData $migrationData): void { add_option(self::CLEAN_INSTALL_REPORT_OPTION, self::$migrationCleanupReport, '', false); } /** * Remove first login after install option * * @param MigrateData $migrationData migration data * * @return void */ public static function removeFirstLoginOption(MigrateData $migrationData): void { delete_option(self::FIRST_LOGIN_OPTION); } /** * Return migration data, * if the site isn't migrated $data->installType = InstState::TYPE_NOT_SET * * @return MigrateData */ public static function getMigrationData() { static $migrationData = null; if (is_null($migrationData)) { if (($migrationData = get_option(self::MIGRATION_DATA_OPTION, false)) === false) { $migrationData = new MigrateData(); } else { $migrationData = JsonSerialize::unserializeToObj($migrationData, MigrateData::class); } } return $migrationData; } /** * Safe mode warning * * @return string */ public static function getSaveModeWarning() { switch (self::getMigrationData()->safeMode) { case 1: //safe_mode basic return __('NOTICE: Safe mode (Basic) was enabled during install, be sure to re-enable all your plugins.', 'duplicator-pro'); case 2: //safe_mode advance return __('NOTICE: Safe mode (Advanced) was enabled during install, be sure to re-enable all your plugins.', 'duplicator-pro'); case 0: default: return ''; } } /** * Check the root path and in case there are installer files without hashes rename them. * * @param int $fileTimeDelay If the file is younger than $fileTimeDelay seconds then it is not renamed. * * @return void */ public static function renameInstallersPhpFiles($fileTimeDelay = 0): void { $fileTimeDelay = is_numeric($fileTimeDelay) ? (int) $fileTimeDelay : 0; $pathsTocheck = [ SnapIO::safePathTrailingslashit(ABSPATH), SnapIO::safePathTrailingslashit(SnapWP::getHomePath()), SnapIO::safePathTrailingslashit(WP_CONTENT_DIR), ]; $migrationData = self::getMigrationData(); if (strlen($migrationData->installerPath)) { $pathsTocheck[] = SnapIO::safePathTrailingslashit(dirname($migrationData->installerPath)); } if (strlen($migrationData->dupInstallerPath)) { $pathsTocheck[] = SnapIO::safePathTrailingslashit(dirname($migrationData->dupInstallerPath)); } $pathsTocheck = array_unique($pathsTocheck); $filesToCheck = []; foreach ($pathsTocheck as $cFolder) { if ( !is_dir($cFolder) || !is_writable($cFolder) // rename permissions ) { continue; } $cFile = $cFolder . 'installer.php'; if ( !is_file($cFile) || !SnapIO::chmod($cFile, 'u+rw') || !is_readable($cFile) ) { continue; } $filesToCheck[] = $cFile; } $installerTplCheck = '/const\s+ARCHIVE_FILENAME\s*=\s*[\'"](.+?)[\'"]\s*;.*const\s+PACKAGE_HASH\s*=\s*[\'"](.+?)[\'"]\s*;/s'; foreach ($filesToCheck as $file) { $fileName = basename($file); if ($fileTimeDelay > 0 && !SnapIO::isOlderThan($file, $fileTimeDelay)) { continue; } if (($content = @file_get_contents($file, false, null)) === false) { continue; } $matches = null; if (preg_match($installerTplCheck, $content, $matches) !== 1) { continue; } $archiveName = $matches[1]; $hash = $matches[2]; $matches = null; if (preg_match(DUPLICATOR_ARCHIVE_REGEX_PATTERN, $archiveName, $matches) !== 1) { if (SnapIO::unlink($file)) { self::$migrationCleanupReport['instFile'][] = "
" . " " . sprintf(__('Installer file %s removed for security reasons', 'duplicator-pro'), esc_html($fileName)) . "
"; } else { self::$migrationCleanupReport['instFile'][] = "
" . ' ' . sprintf(__('Can\'t remove installer file %s, please remove it for security reasons', 'duplicator-pro'), esc_html($fileName)) . '
'; } continue; } $archiveHash = $matches[1]; if (strpos($file, $archiveHash) === false) { if (SnapIO::rename($file, dirname($file) . '/' . $archiveHash . '_installer.php', true)) { self::$migrationCleanupReport['instFile'][] = "
" . " " . sprintf(__('Installer file %s renamed with HASH', 'duplicator-pro'), esc_html($fileName)) . "
"; } else { self::$migrationCleanupReport['instFile'][] = "
" . ' ' . sprintf( __('Can\'t rename installer file %s with HASH, please remove it for security reasons', 'duplicator-pro'), esc_html($fileName) ) . '
'; } } } } /** * Store migratuion files * * @param MigrateData $migrationData Migration data * * @return void */ public static function storeMigrationFiles(MigrateData $migrationData): void { wp_mkdir_p(DUPLICATOR_SSDIR_PATH_INSTALLER); SnapIO::emptyDir(DUPLICATOR_SSDIR_PATH_INSTALLER); SnapIO::createSilenceIndex(DUPLICATOR_SSDIR_PATH_INSTALLER); $filesToMove = [ $migrationData->installerLog, $migrationData->installerBootLog, $migrationData->origFileFolderPath, ]; foreach ($filesToMove as $path) { if (file_exists($path)) { if (SnapIO::rcopy($path, DUPLICATOR_SSDIR_PATH_INSTALLER . '/' . basename($path))) { self::$migrationCleanupReport['stored'][] = "
" . " " . __('Original files folder moved in installer backup directory', 'duplicator-pro') . " - " . esc_html($path) . "
"; } else { self::$migrationCleanupReport['stored'][] = "
" . ' ' . sprintf(__('Can\'t move %1$s to %2$s', 'duplicator-pro'), esc_html($path), DUPLICATOR_SSDIR_PATH_INSTALLER) . '
'; } } } } /** * Get file list to store * * @return array */ public static function getStoredMigrationLists(): array { if (($migrationData = self::getMigrationData()) == false) { $filesToCheck = []; } else { $filesToCheck = [ $migrationData->installerLog => __('Installer log', 'duplicator-pro'), $migrationData->installerBootLog => __('Installer boot log', 'duplicator-pro'), $migrationData->origFileFolderPath => __('Original files folder', 'duplicator-pro'), ]; } $result = []; foreach ($filesToCheck as $path => $label) { $storedPath = DUPLICATOR_SSDIR_PATH_INSTALLER . '/' . basename($path); if (!file_exists($storedPath)) { continue; } $result[$storedPath] = $label; } return $result; } /** * Check if exist file to remove * * @return bool */ public static function haveFileToClean(): bool { return count(self::checkInstallerFilesList()) > 0; } /** * Gets a list of all the installer files and directory by name and full path * * @remarks * FILES: installer.php, installer-backup.php, dup-installer-bootlog__[HASH].txt * DIRS: dup-installer * Last set is for lazy developer cleanup files that a developer may have * accidentally left around lets be proactive for the user just in case. * * @return string[] file names */ public static function getGenericInstallerFiles(): array { return [ 'installer.php', '[HASH]installer-backup.php', 'dup-installer', 'dup-installer[HASH]', 'dup-installer-bootlog__[HASH].txt', '[HASH]_archive.zip|daf', 'dup_cloud_downloader_[HASH].php', 'dup_cloud_downloader_data_[HASH]', ]; } /** * Get installer files list * * @return string[] */ public static function checkInstallerFilesList(): array { $migrationData = self::getMigrationData(); $foldersToChkeck = [ SnapIO::safePathTrailingslashit(ABSPATH), SnapWP::getHomePath(), ]; $result = []; if (!empty($migrationData)) { if ( file_exists($migrationData->archivePath) && !PackageArchive::isBackupPathChild($migrationData->archivePath) && !AbstractPackageDeployer::isDeployPath($migrationData->archivePath) && !apply_filters('duplicator_is_protected_path', false, $migrationData->archivePath) && !StoragesUtil::isLocalStorageChildPath($migrationData->archivePath) ) { $result[] = $migrationData->archivePath; } if ( file_exists($migrationData->installerPath) && self::isInstallerFile($migrationData->installerPath) && !PackageArchive::isBackupPathChild($migrationData->installerPath) && !apply_filters('duplicator_is_protected_path', false, $migrationData->installerPath) && !StoragesUtil::isLocalStorageChildPath($migrationData->installerPath) ) { $result[] = $migrationData->installerPath; } if (file_exists($migrationData->installerBootLog)) { $result[] = $migrationData->installerBootLog; } if (file_exists($migrationData->dupInstallerPath)) { $result[] = $migrationData->dupInstallerPath; } } foreach ($foldersToChkeck as $folder) { $result = array_merge($result, SnapIO::regexGlob($folder, [ 'regexFile' => [ DUPLICATOR_ARCHIVE_REGEX_PATTERN, DUPLICATOR_INSTALLER_REGEX_PATTERN, DUPLICATOR_INSTALLER_BOOTLOG_REGEX_PATTERN, DUPLICATOR_INSTALLER_OWRPARAM_REGEX_PATTERN, DUPLICATOR_CLOUD_DOWNLOADER_REGEX_PATTERN, ], 'regexFolder' => [ DUPLICATOR_INSTALLER_FOLDER_REGEX_PATTERN, DUPLICATOR_CLOUD_DOWNLOADER_FOLDER_REGEX_PATTERN, ], ])); } $result = array_map([SnapIO::class, 'safePathUntrailingslashit'], $result); return array_unique($result); } /** * Check if file is installer file * * @param string $path path to check * * @return bool true if the file at current path is the installer file */ public static function isInstallerFile($path) { if (!is_file($path) || !is_array($last5Lines = SnapIO::getLastLinesOfFile($path, 5)) || empty($last5Lines)) { return false; } return strpos(implode("", $last5Lines), (string) DUPLICATOR_INSTALLER_EOF_MARKER) !== false; } /** * Clean installer files * * @param bool $deleteCleanInstallReportOption Delete clean install report option * @param int $fileTimeDelay File time delay * * @return array Clean result */ public static function cleanMigrationFiles($deleteCleanInstallReportOption = true, $fileTimeDelay = 0): array { $cleanList = self::checkInstallerFilesList(); $result = []; foreach ($cleanList as $path) { $success = false; try { if ($fileTimeDelay <= 0 || time() - filectime($path) > $fileTimeDelay) { $success = (SnapIO::rrmdir($path) !== false); } else { // The file does not even need to be removed yet $success = true; } } catch (Throwable $ex) { $success = false; } $result[$path] = $success; } if ($deleteCleanInstallReportOption) { delete_option(self::CLEAN_INSTALL_REPORT_OPTION); } return $result; } }