# mainwp/6.2.1/class/class-mainwp-backup-handler.php MainWP Dashboard: Self-hosted WordPress Management for Agencies, version 6.2.1. 1,244 lines. - Page: https://pluginprobe.com/plugins/mainwp/6.2.1/code/class/class-mainwp-backup-handler.php - Raw: https://pluginprobe.com/plugins/mainwp/6.2.1/raw/class/class-mainwp-backup-handler.php - Modified: 2026-05-26T15:22:00+00:00 Line numbers below start at 1. Link to a line or a range by appending a fragment to the page URL, for example `https://pluginprobe.com/plugins/mainwp/6.2.1/code/class/class-mainwp-backup-handler.php#L10-L20`. ```php userid; $type = $pTask->type; $exclude = $pTask->exclude; $taskId = $pTask->id; $excludebackup = $pTask->excludebackup; $excludecache = $pTask->excludecache; $excludenonwp = $pTask->excludenonwp; $excludezip = $pTask->excludezip; $pFilename = $pTask->filename; if ( '' === trim( $pFilename ) ) { $pFilename = null; } $backup_result = array(); // Creating a backup. $website = MainWP_DB::instance()->get_website_by_id( $siteid ); $subfolder = str_replace( '%sitename%', MainWP_Utility::sanitize( $website->name ), $subfolder ); $subfolder = str_replace( '%url%', MainWP_Utility::sanitize( MainWP_Utility::get_nice_url( $website->url ) ), $subfolder ); $subfolder = str_replace( '%type%', $type, $subfolder ); $subfolder = str_replace( '%date%', MainWP_Utility::date( 'Ymd' ), $subfolder ); $subfolder = str_replace( '%task%', '', $subfolder ); $subfolder = str_replace( '%', '', $subfolder ); $subfolder = MainWP_Utility::remove_preslash_spaces( $subfolder ); $subfolder = static::normalize_filename( $subfolder ); if ( ! MainWP_System::instance()->is_single_user() && ( $userid !== $website->userid ) ) { throw new MainWP_Exception( 'Undefined error.' ); } $websiteCleanUrl = $website->url; if ( '/' === substr( $websiteCleanUrl, - 1 ) ) { $websiteCleanUrl = substr( $websiteCleanUrl, 0, - 1 ); } $websiteCleanUrl = str_replace( array( 'http://', 'https://', '/' ), array( '', '', '-' ), $websiteCleanUrl ); if ( 'db' === $type ) { $ext = '.sql.' . static::get_current_archive_extension( $website, $pTask ); } else { $ext = '.' . static::get_current_archive_extension( $website, $pTask ); } $file = str_replace( array( '%sitename%', '%url%', '%date%', '%time%', '%type%', ), array( MainWP_Utility::sanitize( $website->name ), $websiteCleanUrl, MainWP_Utility::date( 'm-d-Y' ), MainWP_Utility::date( 'G\hi\ms\s' ), $type, ), $pFilename ); $file = str_replace( '%', '', $file ); $file = static::normalize_filename( $file ); if ( ! empty( $file ) ) { $file .= $ext; } if ( 'zip' === $pTask->archiveFormat ) { $loadFilesBeforeZip = (int) $pTask->loadFilesBeforeZip; } elseif ( '' === $pTask->archiveFormat || 'site' === $pTask->archiveFormat ) { $loadFilesBeforeZip = (int) $website->loadFilesBeforeZip; } else { $loadFilesBeforeZip = 1; } if ( 1 === $loadFilesBeforeZip ) { $loadFilesBeforeZip = get_option( 'mainwp_options_loadFilesBeforeZip' ); $loadFilesBeforeZip = ( 1 === (int) $loadFilesBeforeZip || false === $loadFilesBeforeZip ); } else { $loadFilesBeforeZip = ( 2 === $loadFilesBeforeZip ); } if ( ( 'zip' === $pTask->archiveFormat ) && ( 1 === (int) $pTask->maximumFileDescriptorsOverride ) ) { $maximumFileDescriptorsAuto = ( 1 === (int) $pTask->maximumFileDescriptorsAuto ); $maximumFileDescriptors = $pTask->maximumFileDescriptors; } elseif ( ( '' === $pTask->archiveFormat || 'site' === $pTask->archiveFormat ) && ( 1 === (int) $website->maximumFileDescriptorsOverride ) ) { $maximumFileDescriptorsAuto = ( 1 === (int) $website->maximumFileDescriptorsAuto ); $maximumFileDescriptors = $website->maximumFileDescriptors; } else { $maximumFileDescriptorsAuto = get_option( 'mainwp_maximumFileDescriptorsAuto' ); $maximumFileDescriptors = get_option( 'mainwp_maximumFileDescriptors' ); $maximumFileDescriptors = ( false === $maximumFileDescriptors ? 150 : $maximumFileDescriptors ); } $information = false; $backupTaskProgress = MainWP_DB_Backup::instance()->get_backup_task_progress( $taskId, $website->id ); if ( empty( $backupTaskProgress ) || ( $backupTaskProgress->dtsFetched < $pTask->last_run ) ) { $start = microtime( true ); try { $pid = time(); if ( empty( $backupTaskProgress ) ) { MainWP_DB_Backup::instance()->add_backup_task_progress( $taskId, $website->id, array() ); } MainWP_DB_Backup::instance()->update_backup_task_progress( $taskId, $website->id, array( 'dtsFetched' => time(), 'fetchResult' => wp_json_encode( array() ), 'downloadedDB' => '', 'downloadedDBComplete' => 0, 'downloadedFULL' => '', 'downloadedFULLComplete' => 0, 'removedFiles' => 0, 'attempts' => 0, 'last_error' => '', 'pid' => $pid, ) ); $params = array( 'type' => $type, 'exclude' => $exclude, 'excludebackup' => $excludebackup, 'excludecache' => $excludecache, 'excludenonwp' => $excludenonwp, 'excludezip' => $excludezip, 'ext' => static::get_current_archive_extension( $website, $pTask ), 'file_descriptors_auto' => $maximumFileDescriptorsAuto, 'file_descriptors' => $maximumFileDescriptors, 'loadFilesBeforeZip' => $loadFilesBeforeZip, 'pid' => $pid, 'f' => $file, ); MainWP_Logger::instance()->debug_for_website( $website, 'backup', 'Requesting backup: ' . MainWP_Utility::value_to_string( $params, 1 ) ); $information = MainWP_Connect::fetch_url_authed( $website, 'backup', $params, false, false, false ); } catch ( MainWP_Exception $e ) { MainWP_Logger::instance()->warning_for_website( $website, 'backup', 'ERROR: ' . $e->getMessage() . ' (' . $e->get_message_extra() . ')' ); $stop = microtime( true ); // Bigger then 30 seconds means a timeout. if ( 30 < ( $stop - $start ) ) { MainWP_DB_Backup::instance()->update_backup_task_progress( $taskId, $website->id, array( 'last_error' => wp_json_encode( array( 'message' => $e->getMessage(), 'extra' => $e->get_message_extra(), ) ), ) ); return false; } throw $e; } if ( isset( $information['error'] ) && stristr( $information['error'], 'Another backup process is running' ) ) { return false; } $backupTaskProgress = MainWP_DB_Backup::instance()->update_backup_task_progress( $taskId, $website->id, array( 'fetchResult' => wp_json_encode( $information ) ) ); } elseif ( empty( $backupTaskProgress->fetchResult ) ) { try { $temp = MainWP_Connect::fetch_url_authed( $website, 'backup_checkpid', array( 'pid' => $backupTaskProgress->pid ) ); } catch ( \Exception $e ) { // ok! } if ( ! empty( $temp ) ) { if ( 'stalled' === $temp['status'] ) { if ( 5 > $backupTaskProgress->attempts ) { $backupTaskProgress = MainWP_DB_Backup::instance()->update_backup_task_progress( $taskId, $website->id, array( 'attempts' => $backupTaskProgress->attempts++ ) ); try { $information = MainWP_Connect::fetch_url_authed( $website, 'backup', array( 'type' => $type, 'exclude' => $exclude, 'excludebackup' => $excludebackup, 'excludecache' => $excludecache, 'excludenonwp' => $excludenonwp, 'excludezip' => $excludezip, 'ext' => static::get_current_archive_extension( $website, $pTask ), 'file_descriptors_auto' => $maximumFileDescriptorsAuto, 'file_descriptors' => $maximumFileDescriptors, 'loadFilesBeforeZip' => $loadFilesBeforeZip, 'pid' => $backupTaskProgress->pid, 'append' => '1', 'f' => $temp['file'], ), false, false, false ); if ( isset( $information['error'] ) && stristr( $information['error'], 'Another backup process is running' ) ) { MainWP_DB_Backup::instance()->update_backup_task_progress( $taskId, $website->id, array( 'attempts' => ( $backupTaskProgress->attempts - 1 ) ) ); return false; } } catch ( MainWP_Exception $e ) { return false; } $backupTaskProgress = MainWP_DB_Backup::instance()->update_backup_task_progress( $taskId, $website->id, array( 'fetchResult' => wp_json_encode( $information ) ) ); } else { throw new MainWP_Exception( 'Backup failed after 5 retries.' ); } } elseif ( 'invalid' === $temp['status'] ) { $error = json_decode( $backupTaskProgress->last_error ); if ( ! is_array( $error ) ) { throw new MainWP_Exception( 'Backup failed.' ); } else { throw new MainWP_Exception( $error['message'], $error['extra'] ); //phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped } } elseif ( 'busy' === $temp['status'] ) { return false; } elseif ( 'done' === $temp['status'] ) { if ( 'full' === $type ) { $information['full'] = $temp['file']; $information['db'] = false; } else { $information['full'] = false; $information['db'] = $temp['file']; } $information['size'] = $temp['size']; $backupTaskProgress = MainWP_DB_Backup::instance()->update_backup_task_progress( $taskId, $website->id, array( 'fetchResult' => wp_json_encode( $information ) ) ); } } elseif ( 5 > $backupTaskProgress->attempts ) { $backupTaskProgress = MainWP_DB_Backup::instance()->update_backup_task_progress( $taskId, $website->id, array( 'attempts' => $backupTaskProgress->attempts++ ) ); } else { throw new MainWP_Exception( 'Backup failed after 5 retries.' ); } } if ( false === $information ) { $information = $backupTaskProgress->fetchResult; } if ( isset( $information['error'] ) ) { throw new MainWP_Exception( esc_html( $information['error'] ) ); } elseif ( 'db' === $type && ! $information['db'] ) { throw new MainWP_Exception( 'Database backup failed.' ); } elseif ( 'full' === $type && ! $information['full'] ) { throw new MainWP_Exception( 'Full backup failed.' ); } elseif ( isset( $information['db'] ) ) { $hasWPFileSystem = MainWP_System_Utility::get_wp_file_system(); /** * WordPress filesystem instance. * * @global object */ global $wp_filesystem; $dir = MainWP_System_Utility::get_mainwp_specific_dir( $website->id ); $wp_filesystem->mkdir( $dir, 0750 ); // MWP-1558: tightened from 0777; per-site backup dumps. if ( ! $wp_filesystem->exists( $dir . 'index.php' ) ) { $wp_filesystem->touch( $dir . 'index.php' ); } // Clean old backups from our system. $maxBackups = get_option( 'mainwp_backupsOnServer' ); if ( false === $maxBackups ) { $maxBackups = 1; } if ( 1 !== $backupTaskProgress->removedFiles ) { $dbBackups = array(); $fullBackups = array(); if ( $wp_filesystem->exists( $dir ) ) { $dh = opendir( $dir ); if ( $dh ) { while ( false !== ( $file = readdir( $dh ) ) ) { if ( '.' !== $file && '..' !== $file ) { $theFile = $dir . $file; if ( $information['db'] && static::is_sql_file( $file ) ) { $dbBackups[ filemtime( $theFile ) . $file ] = $theFile; } if ( $information['full'] && static::is_archive( $file ) && ! static::is_sql_archive( $file ) ) { $fullBackups[ filemtime( $theFile ) . $file ] = $theFile; } } } closedir( $dh ); } } krsort( $dbBackups ); krsort( $fullBackups ); $cnt = 0; foreach ( $dbBackups as $key => $dbBackup ) { ++$cnt; if ( $cnt >= $maxBackups ) { $wp_filesystem->delete( $dbBackup ); } } $cnt = 0; foreach ( $fullBackups as $key => $fullBackup ) { ++$cnt; if ( $cnt >= $maxBackups ) { $wp_filesystem->delete( $fullBackup ); } } $backupTaskProgress = MainWP_DB_Backup::instance()->update_backup_task_progress( $taskId, $website->id, array( 'removedFiles' => 1 ) ); } $localBackupFile = null; $fm_date = MainWP_Utility::sanitize_file_name( MainWP_Utility::date( get_option( 'date_format' ) ) ); $fm_time = MainWP_Utility::sanitize_file_name( MainWP_Utility::date( get_option( 'time_format' ) ) ); $what = null; $regexBackupFile = null; if ( $information['db'] ) { $what = 'db'; $regexBackupFile = 'db-' . $websiteCleanUrl . '-(.*)-(.*).sql(\.zip|\.tar|\.tar\.gz|\.tar\.bz2)?'; if ( '' === $backupTaskProgress->downloadedDB ) { $localBackupFile = $dir . 'db-' . $websiteCleanUrl . '-' . $fm_date . '-' . $fm_time; if ( null !== $pFilename ) { $filename = str_replace( array( '%sitename%', '%url%', '%date%', '%time%', '%type%', ), array( MainWP_Utility::sanitize( $website->name ), $websiteCleanUrl, $fm_date, $fm_time, $what, ), $pFilename ); $filename = str_replace( '%', '', $filename ); $localBackupFile = $dir . $filename; } $localBackupFile .= static::get_real_extension( $information['db'] ); $localBackupFile = static::normalize_filename( $localBackupFile ); $backupTaskProgress = MainWP_DB_Backup::instance()->update_backup_task_progress( $taskId, $website->id, array( 'downloadedDB' => $localBackupFile ) ); } else { $localBackupFile = $backupTaskProgress->downloadedDB; } if ( 0 === (int) $backupTaskProgress->downloadedDBComplete ) { // MWP-1548: decrypt at the boundary so download_to_file // sees plaintext credentials. $http_user_plain = MainWP_Credential_Storage::decrypt_credential( $website->http_user ); $http_pass_plain = MainWP_Credential_Storage::decrypt_credential( $website->http_pass ); MainWP_Connect::download_to_file( MainWP_Connect::get_get_data_authed( $website, $information['db'], 'fdl' ), $localBackupFile, $information['size'], $http_user_plain, $http_pass_plain ); $backupTaskProgress = MainWP_DB_Backup::instance()->update_backup_task_progress( $taskId, $website->id, array( 'downloadedDBComplete' => 1 ) ); } } if ( $information['full'] ) { $realExt = static::get_real_extension( $information['full'] ); $what = 'full'; $regexBackupFile = 'full-' . $websiteCleanUrl . '-(.*)-(.*).(zip|tar|tar.gz|tar.bz2)'; if ( '' === $backupTaskProgress->downloadedFULL ) { $localBackupFile = $dir . 'full-' . $websiteCleanUrl . '-' . $fm_date . '-' . $fm_time . $realExt; if ( null !== $pFilename ) { $filename = str_replace( array( '%sitename%', '%url%', '%date%', '%time%', '%type%', ), array( MainWP_Utility::sanitize( $website->name ), $websiteCleanUrl, $fm_date, $fm_time, $what, ), $pFilename ); $filename = str_replace( '%', '', $filename ); $localBackupFile = $dir . $filename . $realExt; } $localBackupFile = static::normalize_filename( $localBackupFile ); $backupTaskProgress = MainWP_DB_Backup::instance()->update_backup_task_progress( $taskId, $website->id, array( 'downloadedFULL' => $localBackupFile ) ); } else { $localBackupFile = $backupTaskProgress->downloadedFULL; } if ( 0 === (int) $backupTaskProgress->downloadedFULLComplete ) { if ( file_exists( $localBackupFile ) ) { $time = filemtime( $localBackupFile ); $minutes = gmdate( 'i', time() ); $seconds = gmdate( 's', time() ); $file_minutes = gmdate( 'i', $time ); $file_seconds = gmdate( 's', $time ); $minuteDiff = $minutes - $file_minutes; if ( 59 === $minuteDiff ) { $minuteDiff = 1; } $secondsdiff = ( $minuteDiff * 60 ) + $seconds - $file_seconds; if ( 60 > $secondsdiff ) { // still downloading. return false; } } // MWP-1548: decrypt at the boundary. $http_user_plain = MainWP_Credential_Storage::decrypt_credential( $website->http_user ); $http_pass_plain = MainWP_Credential_Storage::decrypt_credential( $website->http_pass ); MainWP_Connect::download_to_file( MainWP_Connect::get_get_data_authed( $website, $information['full'], 'fdl' ), $localBackupFile, $information['size'], $http_user_plain, $http_pass_plain ); MainWP_Connect::fetch_url_authed( $website, 'delete_backup', array( 'del' => $information['full'] ) ); $backupTaskProgress = MainWP_DB_Backup::instance()->update_backup_task_progress( $taskId, $website->id, array( 'downloadedFULLComplete' => 1 ) ); } } $unique = $pTask->last_run; do_action( 'mainwp_postprocess_backup_site', $localBackupFile, $what, $subfolder, $regexBackupFile, $website, $taskId, $unique ); $extra_result = apply_filters( 'mainwp_postprocess_backup_sites_feedback', array(), $unique ); if ( is_array( $extra_result ) ) { foreach ( $extra_result as $key => $value ) { $backup_result[ $key ] = $value; } } } else { throw new MainWP_Exception( 'Database backup failed due to an undefined error.' ); } return $backup_result; } /** * Method backup_download_file() * * Download backup file. * * @param mixed $pSiteId Child Site ID. * @param mixed $pType full|db Type of backup. * @param mixed $pUrl Backup location. * @param mixed $pFile Backup File. * * @return bool true|false * @throws MainWP_Exception Error message. * * @uses \MainWP\Dashboard\MainWP_Connect::get_get_data_authed() * @uses \MainWP\Dashboard\MainWP_DB::get_website_by_id() * @uses \MainWP\Dashboard\MainWP_Connect::download_to_file() * @uses \MainWP\Dashboard\MainWP_Utility::end_session() */ public static function backup_download_file( $pSiteId, $pType, $pUrl, $pFile ) { $hasWPFileSystem = MainWP_System_Utility::get_wp_file_system(); /** * WordPress filesystem instance. * * @global object */ global $wp_filesystem; $dir = dirname( $pFile ) . '/'; $wp_filesystem->mkdir( $dir, 0750 ); // MWP-1558: tightened from 0777; backup download destination. if ( ! $wp_filesystem->exists( $dir . 'index.php' ) ) { $wp_filesystem->touch( $dir . 'index.php' ); } // Clean old backups from our system. $maxBackups = get_option( 'mainwp_backupsOnServer' ); if ( false === $maxBackups ) { $maxBackups = 1; } $dbBackups = array(); $fullBackups = array(); if ( file_exists( $dir ) ) { $dh = opendir( $dir ); if ( $dh ) { while ( false !== ( $file = readdir( $dh ) ) ) { if ( '.' !== $file && '..' !== $file ) { $theFile = $dir . $file; if ( 'db' === $pType && static::is_sql_file( $file ) ) { $dbBackups[ filemtime( $theFile ) . $file ] = $theFile; } if ( 'full' === $pType && static::is_archive( $file ) && ! static::is_sql_archive( $file ) ) { $fullBackups[ filemtime( $theFile ) . $file ] = $theFile; } } } closedir( $dh ); } } krsort( $dbBackups ); krsort( $fullBackups ); $cnt = 0; foreach ( $dbBackups as $key => $dbBackup ) { ++$cnt; if ( $cnt >= $maxBackups ) { $wp_filesystem->delete( $dbBackup ); } } $cnt = 0; foreach ( $fullBackups as $key => $fullBackup ) { ++$cnt; if ( $cnt >= $maxBackups ) { $wp_filesystem->delete( $fullBackup ); } } $website = MainWP_DB::instance()->get_website_by_id( $pSiteId ); MainWP_Utility::end_session(); // MWP-1548: decrypt once at function boundary; both branches use // the same credentials. $http_user_plain = MainWP_Credential_Storage::decrypt_credential( $website->http_user ); $http_pass_plain = MainWP_Credential_Storage::decrypt_credential( $website->http_pass ); if ( 'db' === $pType ) { MainWP_Connect::download_to_file( MainWP_Connect::get_get_data_authed( $website, $pUrl, 'fdl' ), $pFile, false, $http_user_plain, $http_pass_plain ); } if ( 'full' === $pType ) { MainWP_Connect::download_to_file( MainWP_Connect::get_get_data_authed( $website, $pUrl, 'fdl' ), $pFile, false, $http_user_plain, $http_pass_plain ); } return true; } /** * Method backup_delete_file(). * * Delete backup file. * * @param mixed $pSiteId Child Site ID. * @param mixed $pFile File to delete. * * @return bool true * * @uses \MainWP\Dashboard\MainWP_Connect::fetch_url_authed() * @uses \MainWP\Dashboard\MainWP_DB::get_website_by_id() */ public static function backup_delete_file( $pSiteId, $pFile ) { $website = MainWP_DB::instance()->get_website_by_id( $pSiteId ); MainWP_Connect::fetch_url_authed( $website, 'delete_backup', array( 'del' => $pFile ) ); return true; } /** * Method backup_check_pid() * * Check backup pid. * * @param mixed $pSiteId Child Site id. * @param mixed $pid Backup pid. * @param mixed $type full|db Type of backup. * @param mixed $subfolder Sub folder for backup. * @param mixed $pFilename Backups filename. * * @return array $status, $result. * @throws \MainWP_Exception Error message. * * @uses \MainWP\Dashboard\MainWP_System_Utility::get_mainwp_specific_dir() * @uses \MainWP\Dashboard\MainWP_DB::get_website_by_id() * @uses \MainWP\Dashboard\MainWP_Utility::end_session() * @uses \MainWP\Dashboard\MainWP_Utility::sanitize() * @uses \MainWP\Dashboard\MainWP_Utility::get_nice_url() * @uses \MainWP\Dashboard\MainWP_Utility::date() * @uses \MainWP\Dashboard\MainWP_Utility::remove_preslash_spaces() * @uses \MainWP\Dashboard\static::normalize_filename() * @uses \MainWP\Dashboard\MainWP_Utility::sanitize_file_name() * @uses \MainWP\Dashboard\static::get_real_extension() */ public static function backup_check_pid( $pSiteId, $pid, $type, $subfolder, $pFilename ) { $website = MainWP_DB::instance()->get_website_by_id( $pSiteId ); MainWP_Utility::end_session(); $information = MainWP_Connect::fetch_url_authed( $website, 'backup_checkpid', array( 'pid' => $pid ) ); $status = $information['status']; $result = isset( $information['file'] ) ? array( 'file' => $information['file'] ) : array(); if ( 'done' === $status ) { $result['file'] = $information['file']; $result['size'] = $information['size']; $subfolder = str_replace( '%sitename%', MainWP_Utility::sanitize( $website->name ), $subfolder ); $subfolder = str_replace( '%url%', MainWP_Utility::sanitize( MainWP_Utility::get_nice_url( $website->url ) ), $subfolder ); $subfolder = str_replace( '%type%', $type, $subfolder ); $subfolder = str_replace( '%date%', MainWP_Utility::date( 'Ymd' ), $subfolder ); $subfolder = str_replace( '%task%', '', $subfolder ); $subfolder = str_replace( '%', '', $subfolder ); $subfolder = MainWP_Utility::remove_preslash_spaces( $subfolder ); $subfolder = static::normalize_filename( $subfolder ); $result['subfolder'] = $subfolder; $websiteCleanUrl = $website->url; if ( '/' === substr( $websiteCleanUrl, - 1 ) ) { $websiteCleanUrl = substr( $websiteCleanUrl, 0, - 1 ); } $websiteCleanUrl = str_replace( array( 'http://', 'https://', '/' ), array( '', '', '-', ), $websiteCleanUrl ); $dir = MainWP_System_Utility::get_mainwp_specific_dir( $pSiteId ); $fm_date = MainWP_Utility::sanitize_file_name( MainWP_Utility::date( get_option( 'date_format' ) ) ); $fm_time = MainWP_Utility::sanitize_file_name( MainWP_Utility::date( get_option( 'time_format' ) ) ); if ( 'db' === $type ) { $localBackupFile = $dir . 'db-' . $websiteCleanUrl . '-' . $fm_date . '-' . $fm_time . static::get_real_extension( $information['file'] ); $localRegexFile = 'db-' . $websiteCleanUrl . '-(.*)-(.*).sql(\.zip|\.tar|\.tar\.gz|\.tar\.bz2)?'; } else { $localBackupFile = $dir . 'full-' . $websiteCleanUrl . '-' . $fm_date . '-' . $fm_time . static::get_real_extension( $information['file'] ); $localRegexFile = 'full-' . $websiteCleanUrl . '-(.*)-(.*).(zip|tar|tar.gz|tar.bz2)'; } if ( null !== $pFilename ) { $filename = str_replace( array( '%sitename%', '%url%', '%date%', '%time%', '%type%', ), array( MainWP_Utility::sanitize( $website->name ), $websiteCleanUrl, $fm_date, $fm_time, $type, ), $pFilename ); $filename = str_replace( '%', '', $filename ); $localBackupFile = $dir . $filename; $localBackupFile = static::normalize_filename( $localBackupFile ); if ( 'db' === $type ) { $localBackupFile .= static::get_real_extension( $information['file'] ); } else { $localBackupFile .= static::get_real_extension( $information['file'] ); } } $result['local'] = $localBackupFile; $result['regexfile'] = $localRegexFile; } return array( 'status' => $status, 'result' => $result, ); } /** * Method backup() * * Backup Child Site. * * @param mixed $pSiteId Child Site ID. * @param mixed $pType full|db Typ of backup. * @param mixed $pSubfolder Sub folder to store backup. * @param mixed $pExclude Exclusion list. * @param mixed $excludebackup Exclude backup files. * @param mixed $excludecache Exclude cache files. * @param mixed $excludenonwp Exclude no WP Files. * @param mixed $excludezip Exclude Zip files. * @param null $pFilename Name of backup file. * @param string $pFileNameUID File name unique ID. * @param bool $pArchiveFormat Archive format. * @param bool $pMaximumFileDescriptorsOverride Override maximum file descriptors. * @param bool $pMaximumFileDescriptorsAuto Auto maximum file descriptors. * @param bool $pMaximumFileDescriptors Maximum file descriptors. * @param bool $pLoadFilesBeforeZip Load files before zip. * @param bool $pid Backup pid. * @param bool $append Append to backup. * * @return mixed $backup_result * @throws MainWP_Exception Error message. * * @uses \MainWP\Dashboard\MainWP_Connect::fetch_url_authed() * @uses \MainWP\Dashboard\MainWP_Exception * @uses \MainWP\Dashboard\MainWP_DB::get_website_by_id() * @uses \MainWP\Dashboard\MainWP_Logger::debug_for_website() * @uses \MainWP\Dashboard\MainWP_System_Utility::can_edit_website() * @uses \MainWP\Dashboard\MainWP_System_Utility::get_mainwp_specific_dir() * @uses \MainWP\Dashboard\MainWP_Utility::sanitize() * @uses \MainWP\Dashboard\MainWP_Utility::date() * @uses \MainWP\Dashboard\MainWP_Utility::remove_preslash_spaces() * @uses \MainWP\Dashboard\static::normalize_filename() * @uses \MainWP\Dashboard\MainWP_Utility::sanitize_file_name() * @uses \MainWP\Dashboard\MainWP_Utility::end_session() * @uses \MainWP\Dashboard\MainWP_Utility::value_to_string() * @uses \MainWP\Dashboard\static::get_real_extension() */ public static function backup( $pSiteId, $pType, $pSubfolder, $pExclude, $excludebackup, $excludecache, $excludenonwp, $excludezip, $pFilename = null, $pFileNameUID = '', $pArchiveFormat = false, $pMaximumFileDescriptorsOverride = false, $pMaximumFileDescriptorsAuto = false, $pMaximumFileDescriptors = false, $pLoadFilesBeforeZip = false, $pid = false, $append = false ) { if ( ! get_option( 'mainwp_enableLegacyBackupFeature' ) ) { return false; } if ( '' === trim( $pFilename ) ) { $pFilename = null; } $backup_result = array(); $website = MainWP_DB::instance()->get_website_by_id( $pSiteId ); $subfolder = str_replace( '%sitename%', MainWP_Utility::sanitize( $website->name ), $pSubfolder ); $subfolder = str_replace( '%url%', MainWP_Utility::sanitize( MainWP_Utility::get_nice_url( $website->url ) ), $subfolder ); $subfolder = str_replace( '%type%', $pType, $subfolder ); $subfolder = str_replace( '%date%', MainWP_Utility::date( 'Ymd' ), $subfolder ); $subfolder = str_replace( '%task%', '', $subfolder ); $subfolder = str_replace( '%', '', $subfolder ); $subfolder = MainWP_Utility::remove_preslash_spaces( $subfolder ); $subfolder = static::normalize_filename( $subfolder ); if ( MainWP_System_Utility::is_suspended_site( $website ) ) { throw new MainWP_Exception( 'Suspended site.', '', 'SUSPENDED_SITE' ); } if ( ! MainWP_System_Utility::can_edit_website( $website ) ) { throw new MainWP_Exception( 'You are not allowed to backup this site' ); } $websiteCleanUrl = $website->url; if ( '/' === substr( $websiteCleanUrl, - 1 ) ) { $websiteCleanUrl = substr( $websiteCleanUrl, 0, - 1 ); } $websiteCleanUrl = str_replace( array( 'http://', 'https://', '/' ), array( '', '', '-' ), $websiteCleanUrl ); if ( false === $pMaximumFileDescriptorsOverride ) { if ( 1 === (int) $website->maximumFileDescriptorsOverride ) { $maximumFileDescriptorsAuto = ( 1 === (int) $website->maximumFileDescriptorsAuto ); $maximumFileDescriptors = $website->maximumFileDescriptors; } else { $maximumFileDescriptorsAuto = get_option( 'mainwp_maximumFileDescriptorsAuto' ); $maximumFileDescriptors = get_option( 'mainwp_maximumFileDescriptors' ); $maximumFileDescriptors = ( false === $maximumFileDescriptors ? 150 : $maximumFileDescriptors ); } } elseif ( ( 'global' !== $pArchiveFormat ) && ( 1 === (int) $pMaximumFileDescriptorsOverride ) ) { $maximumFileDescriptorsAuto = ( 1 === $pMaximumFileDescriptorsAuto ); $maximumFileDescriptors = $pMaximumFileDescriptors; } else { $maximumFileDescriptorsAuto = get_option( 'mainwp_maximumFileDescriptorsAuto' ); $maximumFileDescriptors = get_option( 'mainwp_maximumFileDescriptors' ); $maximumFileDescriptors = ( false === $maximumFileDescriptors ? 150 : $maximumFileDescriptors ); } $file = str_replace( array( '%sitename%', '%url%', '%date%', '%time%', '%type%', ), array( MainWP_Utility::sanitize( $website->name ), $websiteCleanUrl, MainWP_Utility::date( 'm-d-Y' ), MainWP_Utility::date( 'G\hi\ms\s' ), $pType, ), $pFilename ); $file = str_replace( '%', '', $file ); $file = static::normalize_filename( $file ); // Normal flow: check site settings & fallback to global. if ( false === $pLoadFilesBeforeZip ) { $loadFilesBeforeZip = $website->loadFilesBeforeZip; if ( 1 === $loadFilesBeforeZip ) { $loadFilesBeforeZip = get_option( 'mainwp_options_loadFilesBeforeZip' ); $loadFilesBeforeZip = ( 1 === $loadFilesBeforeZip || false === $loadFilesBeforeZip ); } else { $loadFilesBeforeZip = ( 2 === $loadFilesBeforeZip ); } } elseif ( 'global' === $pArchiveFormat || 1 === $pLoadFilesBeforeZip ) { // Overridden flow: only fallback to global. $loadFilesBeforeZip = get_option( 'mainwp_options_loadFilesBeforeZip' ); $loadFilesBeforeZip = ( 1 === $loadFilesBeforeZip || false === $loadFilesBeforeZip ); } else { $loadFilesBeforeZip = ( 2 === $pLoadFilesBeforeZip ); } // Normal flow: check site settings & fallback to global. if ( false === $pArchiveFormat ) { $archiveFormat = static::get_current_archive_extension( $website ); } elseif ( 'global' === $pArchiveFormat ) { $archiveFormat = static::get_current_archive_extension(); } else { $archiveFormat = $pArchiveFormat; } MainWP_Utility::end_session(); $params = array( 'type' => $pType, 'exclude' => $pExclude, 'excludebackup' => $excludebackup, 'excludecache' => $excludecache, 'excludenonwp' => $excludenonwp, 'excludezip' => $excludezip, 'ext' => $archiveFormat, 'file_descriptors_auto' => $maximumFileDescriptorsAuto, 'file_descriptors' => $maximumFileDescriptors, 'loadFilesBeforeZip' => $loadFilesBeforeZip, 'f' => $file, 'fileUID' => $pFileNameUID, 'pid' => $pid, 'append' => ( $append ? 1 : 0 ), ); MainWP_Logger::instance()->debug_for_website( $website, 'backup', 'Requesting backup: ' . MainWP_Utility::value_to_string( $params, 1 ) ); $information = MainWP_Connect::fetch_url_authed( $website, 'backup', $params, false, false, false ); do_action( 'mainwp_managesite_backup', $website, array( 'type' => $pType ), $information ); if ( isset( $information['error'] ) ) { throw new MainWP_Exception( esc_html( $information['error'] ) ); //phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped } elseif ( 'db' === $pType && ! $information['db'] ) { throw new MainWP_Exception( 'Database backup failed.' ); } elseif ( 'full' === $pType && ! $information['full'] ) { throw new MainWP_Exception( 'Full backup failed.' ); } elseif ( isset( $information['db'] ) || isset( $information['full'] ) ) { if ( ! empty( $information['db'] ) ) { $backup_result['url'] = $information['db']; $backup_result['type'] = 'db'; } elseif ( ! empty( $information['full'] ) ) { $backup_result['url'] = $information['full']; $backup_result['type'] = 'full'; } if ( isset( $information['size'] ) ) { $backup_result['size'] = $information['size']; } $backup_result['subfolder'] = $subfolder; $dir = MainWP_System_Utility::get_mainwp_specific_dir( $pSiteId ); $fm_date = MainWP_Utility::sanitize_file_name( MainWP_Utility::date( get_option( 'date_format' ) ) ); $fm_time = MainWP_Utility::sanitize_file_name( MainWP_Utility::date( get_option( 'time_format' ) ) ); if ( 'db' === $pType ) { $localBackupFile = $dir . 'db-' . $websiteCleanUrl . '-' . $fm_date . '-' . $fm_time . static::get_real_extension( $information['db'] ); $localRegexFile = 'db-' . $websiteCleanUrl . '-(.*)-(.*).sql(\.zip|\.tar|\.tar\.gz|\.tar\.bz2)?'; } else { $localBackupFile = $dir . 'full-' . $websiteCleanUrl . '-' . $fm_date . '-' . $fm_time . static::get_real_extension( $information['full'] ); $localRegexFile = 'full-' . $websiteCleanUrl . '-(.*)-(.*).(zip|tar|tar.gz|tar.bz2)'; } if ( null !== $pFilename ) { $filename = str_replace( array( '%sitename%', '%url%', '%date%', '%time%', '%type%', ), array( MainWP_Utility::sanitize( $website->name ), $websiteCleanUrl, $fm_date, $fm_time, $pType, ), $pFilename ); $filename = str_replace( '%', '', $filename ); $localBackupFile = $dir . $filename; $localBackupFile = static::normalize_filename( $localBackupFile ); if ( 'db' === $pType ) { $localBackupFile .= static::get_real_extension( $information['db'] ); } else { $localBackupFile .= static::get_real_extension( $information['full'] ); } } $backup_result['local'] = $localBackupFile; $backup_result['regexfile'] = $localRegexFile; return $backup_result; } else { throw new MainWP_Exception( 'Database backup failed due to an undefined error' ); } } /** * Method normalize_filename() * * Normalize filename. * * @param mixed $s Filename to normalize. * * @return string $s Normalised filename. */ public static function normalize_filename( $s ) { $s = preg_replace( '@\x{00c4}@u', 'A', $s ); $s = preg_replace( '@\x{00d6}@u', 'O', $s ); $s = preg_replace( '@\x{00dc}@u', 'U', $s ); $s = preg_replace( '@\x{00cb}@u', 'E', $s ); $s = preg_replace( '@\x{00e4}@u', 'a', $s ); $s = preg_replace( '@\x{00f6}@u', 'o', $s ); $s = preg_replace( '@\x{00fc}@u', 'u', $s ); $s = preg_replace( '@\x{00eb}@u', 'e', $s ); $s = preg_replace( '@\x{00f1}@u', 'n', $s ); $s = preg_replace( '@\x{00ff}@u', 'y', $s ); return $s; } /** * Method is_archive() * * Check if Archive. * * @param mixed $pFileName File to check. * @param string $pPrefix File prefix. * @param string $pSuffix File suffix. * * @return mixed Files that are archives. */ public static function is_archive( $pFileName, $pPrefix = '', $pSuffix = '' ) { return preg_match( '/' . $pPrefix . '(.*).(zip|tar|tar.gz|tar.bz2)' . $pSuffix . '$/', $pFileName ); } /** * Method is_sql_file() * * Check if file is SQL. * * @param mixed $pFileName File to check. * * @return mixed SQL Files. */ public static function is_sql_file( $pFileName ) { return preg_match( '/(.*).sql$/', $pFileName ) || static::is_sql_archive( $pFileName ); } /** * Method is_sql_archive() * * Check if is SQL Archive. * * @param mixed $pFileName File to check. * * @return mixed SQL archive. */ public static function is_sql_archive( $pFileName ) { return preg_match( '/(.*).sql.(zip|tar|tar.gz|tar.bz2)$/', $pFileName ); } /** * Method get_current_archive_extension() * * Get extension of current Archive. * * @param bool $website true|false. * @param bool|string $task true|false|global|site. * * @return mixed $archiveFormat Format of Archive. * * @uses \MainWP\Dashboard\MainWP_DB_Backup::get_website_backup_settings() */ public static function get_current_archive_extension( $website = false, $task = false ) { $useSite = true; if ( false !== $task ) { if ( 'global' === $task->archiveFormat ) { $useGlobal = true; $useSite = false; } elseif ( '' === $task->archiveFormat || 'site' === $task->archiveFormat ) { $useGlobal = false; $useSite = true; } else { $archiveFormat = $task->archiveFormat; $useGlobal = false; $useSite = false; } } if ( $useSite ) { if ( false === $website ) { $useGlobal = true; } else { $backupSettings = MainWP_DB_Backup::instance()->get_website_backup_settings( $website->id ); $archiveFormat = $backupSettings->archiveFormat; $useGlobal = ( 'global' === $archiveFormat ); } } if ( $useGlobal ) { $archiveFormat = get_option( 'mainwp_archiveFormat' ); if ( false === $archiveFormat ) { $archiveFormat = 'tar.gz'; } } return $archiveFormat; } /** * Method get_real_extension() * * Get full file extension. * * @param mixed $path Path to file. * * @return mixed $check|pathinfo() */ public static function get_real_extension( $path ) { $checks = array( '.sql.zip', '.sql.tar', '.sql.tar.gz', '.sql.tar.bz2', '.tar.gz', '.tar.bz2' ); foreach ( $checks as $check ) { if ( MainWP_Utility::ends_with( $path, $check ) ) { return $check; } } return '.' . pathinfo( $path, PATHINFO_EXTENSION ); } /** * Method handle_settings_post() * * Update Child Site Settings. * * @return bool true|false * * @uses \MainWP\Dashboard\MainWP_System_Utility::is_admin() * @uses \MainWP\Dashboard\MainWP_Utility::update_option() */ public static function handle_settings_post() { if ( MainWP_System_Utility::is_admin() ) { if ( isset( $_POST['submit'] ) && isset( $_POST['wp_nonce'] ) && wp_verify_nonce( sanitize_key( $_POST['wp_nonce'] ), 'Settings' ) ) { if ( isset( $_POST['mainwp_options_backupOnServer'] ) && 0 < $_POST['mainwp_options_backupOnServer'] ) { MainWP_Utility::update_option( 'mainwp_backupsOnServer', ( isset( $_POST['mainwp_options_backupOnServer'] ) ? intval( $_POST['mainwp_options_backupOnServer'] ) : 1 ) ); } if ( isset( $_POST['mainwp_options_maximumFileDescriptors'] ) && - 1 < $_POST['mainwp_options_maximumFileDescriptors'] ) { MainWP_Utility::update_option( 'mainwp_maximumFileDescriptors', ( isset( $_POST['mainwp_options_maximumFileDescriptors'] ) ? intval( $_POST['mainwp_options_maximumFileDescriptors'] ) : 1 ) ); } MainWP_Utility::update_option( 'mainwp_maximumFileDescriptorsAuto', ( ! isset( $_POST['mainwp_maximumFileDescriptorsAuto'] ) ? 0 : 1 ) ); if ( ! empty( $_POST['mainwp_options_backupOnExternalSources'] ) && 0 <= $_POST['mainwp_options_backupOnExternalSources'] ) { MainWP_Utility::update_option( 'mainwp_backupOnExternalSources', ( isset( $_POST['mainwp_options_backupOnExternalSources'] ) ? intval( $_POST['mainwp_options_backupOnExternalSources'] ) : 1 ) ); } MainWP_Utility::update_option( 'mainwp_archiveFormat', ( isset( $_POST['mainwp_archiveFormat'] ) ? sanitize_text_field( wp_unslash( $_POST['mainwp_archiveFormat'] ) ) : '' ) ); $old_primaryBackup = get_option( 'mainwp_primaryBackup' ); $old_enableLegacyBackup = get_option( 'mainwp_enableLegacyBackupFeature' ); $updated_enableLegacyBackup = false; if ( isset( $_POST['mainwp_primaryBackup'] ) ) { if ( ! empty( $_POST['mainwp_primaryBackup'] ) ) { // not default backup method. MainWP_Utility::update_option( 'mainwp_notificationOnBackupFail', 0 ); MainWP_Utility::update_option( 'mainwp_notificationOnBackupStart', 0 ); MainWP_Utility::update_option( 'mainwp_chunkedBackupTasks', 0 ); if ( empty( $old_primaryBackup ) ) { MainWP_Utility::update_option( 'mainwp_enableLegacyBackupFeature', 0 ); $updated_enableLegacyBackup = true; } } MainWP_Utility::update_option( 'mainwp_primaryBackup', sanitize_text_field( wp_unslash( $_POST['mainwp_primaryBackup'] ) ) ); } if ( ! isset( $_POST['mainwp_primaryBackup'] ) || empty( $_POST['mainwp_primaryBackup'] ) ) { MainWP_Utility::update_option( 'mainwp_options_loadFilesBeforeZip', ( ! isset( $_POST['mainwp_options_loadFilesBeforeZip'] ) ? 0 : 1 ) ); MainWP_Utility::update_option( 'mainwp_notificationOnBackupFail', ( ! isset( $_POST['mainwp_options_notificationOnBackupFail'] ) ? 0 : 1 ) ); MainWP_Utility::update_option( 'mainwp_notificationOnBackupStart', ( ! isset( $_POST['mainwp_options_notificationOnBackupStart'] ) ? 0 : 1 ) ); MainWP_Utility::update_option( 'mainwp_chunkedBackupTasks', ( ! isset( $_POST['mainwp_options_chunkedBackupTasks'] ) ? 0 : 1 ) ); } $enableLegacyBackup = ( isset( $_POST['mainwp_options_enableLegacyBackupFeature'] ) && ! empty( $_POST['mainwp_options_enableLegacyBackupFeature'] ) ) ? 1 : 0; if ( $enableLegacyBackup && empty( $old_enableLegacyBackup ) ) { MainWP_Utility::update_option( 'mainwp_primaryBackup', '' ); } if ( ! $updated_enableLegacyBackup ) { MainWP_Utility::update_option( 'mainwp_enableLegacyBackupFeature', $enableLegacyBackup ); } return true; } } return false; } /** * Method backup_get_file_size() * * Get file size. * * @param mixed $pFile Backup file. * * @return false|int * * @uses \MainWP\Dashboard\MainWP_System_Utility::get_mainwp_specific_dir() */ public static function backup_get_file_size( $pFile ) { $dir = MainWP_System_Utility::get_mainwp_specific_dir(); if ( stristr( $pFile, $dir ) && file_exists( $pFile ) ) { return filesize( $pFile ); } return 0; } } ```