File: /home/thwoodlg/public_html/wp-content/plugins/duplicator-pro/classes/package/class.pack.runner.php
<?php
defined("ABSPATH") or die("");
/*
Duplicator Pro Plugin
Copyright (C) 2016, Snap Creek LLC
website: snapcreek.com
Duplicator Pro Plugin is distributed under the GNU General Public License, Version 3,
June 2007. Copyright (C) 2007 Free Software Foundation, Inc., 51 Franklin
St, Fifth Floor, Boston, MA 02110, USA
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
require_once(DUPLICATOR_PRO_PLUGIN_PATH . '/classes/entities/class.secure.global.entity.php');
require_once(DUPLICATOR_PRO_PLUGIN_PATH . '/classes/entities/class.system.global.entity.php');
require_once(DUPLICATOR_PRO_PLUGIN_PATH . '/classes/entities/class.schedule.entity.php');
require_once(DUPLICATOR_PRO_PLUGIN_PATH . '/classes/package/class.pack.php');
require_once(DUPLICATOR_PRO_PLUGIN_PATH . '/classes/class.server.php');
require_once(DUPLICATOR_PRO_PLUGIN_PATH . '/classes/class.system.checker.php');
require_once(DUPLICATOR_PRO_PLUGIN_PATH . '/lib/snaplib/class.snaplib.u.url.php');
if (!class_exists('DUP_PRO_Package_Runner')) {
class DUP_PRO_Package_Runner
{
public static $delayed_exit_and_kickoff = false;
public static function init()
{
$kick_off_worker = false;
/* @var $global DUP_PRO_Global_Entity */
$global = DUP_PRO_Global_Entity::get_instance();
if($global->clientside_kickoff === false) {
/* @var $system_global DUP_PRO_System_Global_Entity */
$system_global = DUP_PRO_System_Global_Entity::get_instance();
if((time() - $system_global->package_check_ts) < DUP_PRO_Constants::PACKAGE_CHECK_TIME_IN_SEC) {
DUP_PRO_LOG::trace("skipping package runner init");
return;
}
$system_global->package_check_ts = time();
$system_global->save();
}
DUP_PRO_LOG::trace('Running package runner init');
if ($global == null) {
DUP_PRO_LOG::trace("Global appears to not be initialized yet so returning from init without processing.");
return;
}
if ($global->lock_mode == DUP_PRO_Thread_Lock_Mode::Flock) {
$locking_file = @fopen(DUP_PRO_Constants::$LOCKING_FILE_FILENAME, 'c+');
} else {
$locking_file = true;
}
if ($locking_file != false) {
if ($global->lock_mode == DUP_PRO_Thread_Lock_Mode::Flock) {
$acquired_lock = (flock($locking_file, LOCK_EX | LOCK_NB) != false);
if ($acquired_lock) {
DUP_PRO_LOG::trace("File lock acquired: ".$locking_file);
} else {
DUP_PRO_LOG::trace("File lock denied ".$locking_file);
}
} else {
$acquired_lock = DUP_PRO_U::getSqlLock();
}
if ($acquired_lock) {
DUP_PRO_System_Checker::check();
$pending_cancellations = DUP_PRO_Package::get_pending_cancellations();
// Try to minimize the impact of checking for long running
if (time() % 5 == 0) {
self::cancel_long_running($pending_cancellations);
}
if (count($pending_cancellations) > 0) {
foreach ($pending_cancellations as $package_id_to_cancel) {
DUP_PRO_LOG::trace("looking to cancel $package_id_to_cancel");
$package_to_cancel = DUP_PRO_Package::get_by_id((int) $package_id_to_cancel);
if ($package_to_cancel != null) {
if ($package_to_cancel->Status == DUP_PRO_PackageStatus::STORAGE_PROCESSING) {
do_action('duplicator_pro_package_before_set_status' , $package_to_cancel , DUP_PRO_PackageStatus::STORAGE_CANCELLED);
$package_to_cancel->Status = DUP_PRO_PackageStatus::STORAGE_CANCELLED;
$package_to_cancel->cancel_all_uploads();
$package_to_cancel->update();
do_action('duplicator_pro_package_after_set_status' , $package_to_cancel , DUP_PRO_PackageStatus::STORAGE_CANCELLED);
if ($package_to_cancel->schedule_id != -1) {
add_action('plugins_loaded', array($package_to_cancel, 'post_scheduled_storage_failure'));
}
} else {
do_action('duplicator_pro_package_before_set_status' , $package_to_cancel , DUP_PRO_PackageStatus::BUILD_CANCELLED);
$package_to_cancel->Status = DUP_PRO_PackageStatus::BUILD_CANCELLED;
$package_to_cancel->update();
do_action('duplicator_pro_package_after_set_status' , $package_to_cancel , DUP_PRO_PackageStatus::BUILD_CANCELLED);
if ($package_to_cancel->schedule_id != -1) {
add_action('plugins_loaded', array($package_to_cancel, 'post_scheduled_build_failure'));
}
}
}
}
DUP_PRO_Package::clear_pending_cancellations();
}
if ((!isset($_REQUEST['action'])) || ((isset($_REQUEST['action']) && ($_REQUEST['action'] != 'duplicator_pro_process_worker')))) {
self::process_schedules();
$kick_off_worker = DUP_PRO_Package::is_active_package_present();
}
if ($global->lock_mode == DUP_PRO_Thread_Lock_Mode::Flock) {
if (!flock($locking_file, LOCK_UN)) {
DUP_PRO_LOG::trace("File lock cant release ".$locking_file);
} else {
DUP_PRO_LOG::trace("File lock released ".$locking_file);
}
fclose($locking_file);
} else {
DUP_PRO_U::releaseSqlLock();
}
}
} else {
DUP_PRO_LOG::trace("Problem opening locking file so auto switching to SQL lock mode");
$global->lock_mode = DUP_PRO_Thread_Lock_Mode::SQL_Lock;
$global->save();
exit();
}
if ($kick_off_worker || self::$delayed_exit_and_kickoff) {
self::kick_off_worker();
} else if (is_admin() && (isset($_REQUEST['page']) && (strpos($_REQUEST['page'], DUP_PRO_Constants::PLUGIN_SLUG) !== false))) {
DUP_PRO_LOG::trace("************kicking off slug worker");
// If it's one of our pages force it to kick off the client
self::kick_off_worker(true);
}
if (self::$delayed_exit_and_kickoff) {
self::$delayed_exit_and_kickoff = false;
exit();
}
}
public static function add_kickoff_worker_javascript()
{
$global = DUP_PRO_Global_Entity::get_instance();
$custom_url = strtolower($global->custom_ajax_url);
$CLIENT_CALL_PERIOD_IN_MS = 20000; // How often client calls into the service
if ($global->ajax_protocol == 'custom') {
if (DUP_PRO_STR::startsWith($custom_url, 'http')) {
$ajax_url = $custom_url;
} else {
// Revert to http standard if they don't have the url correct
$ajax_url = admin_url('admin-ajax.php', 'http');
DUP_PRO_LOG::trace("Even though custom ajax url configured, incorrect url set so reverting to $ajax_url");
}
} else {
$ajax_url = admin_url('admin-ajax.php', $global->ajax_protocol);
}
$gateway = array(
'ajaxurl' => $ajax_url,
'client_call_frequency' => $CLIENT_CALL_PERIOD_IN_MS,
'duplicator_pro_process_worker_nonce' => wp_create_nonce('duplicator_pro_process_worker'),
);
wp_register_script('dup-pro-kick', DUPLICATOR_PRO_PLUGIN_URL . 'assets/js/dp-kick.js', array('jquery'), DUPLICATOR_PRO_VERSION);
wp_localize_script('dup-pro-kick', 'dp_gateway', $gateway);
DUP_PRO_LOG::trace('KICKOFF: Client Side');
wp_enqueue_script('dup-pro-kick');
}
public static function cancel_long_running(&$pending_cancellations)
{
/* @var $global DUP_PRO_Global_Entity */
$global = DUP_PRO_Global_Entity::get_instance();
/* @var $active_package DUP_PRO_Package */
if (DUP_PRO_Package::is_active_package_present()) {
$active_package = DUP_PRO_Package::get_next_active_package();
if (($global->max_package_runtime_in_min > 0) && ($active_package != null) && ($active_package->timer_start > 0)) {
$current_time = DUP_PRO_U::getMicrotime();
$elapsed_sec = $current_time - $active_package->timer_start;
$elapsed_minutes = $elapsed_sec / 60;
if ($elapsed_minutes > $global->max_package_runtime_in_min) {
$error_text = DUP_PRO_U::__('Package was cancelled because it exceeded Max Build Time.');
$fix_text = DUP_PRO_U::__('Click button to increase Max Build Time.');
$system_global = DUP_PRO_System_Global_Entity::get_instance();
$system_global->add_recommended_quick_fix($error_text, $fix_text, 'global:{max_package_runtime_in_min:270}');
$system_global->save();
DUP_PRO_LOG::trace("Package $active_package->ID has been going for $elapsed_minutes minutes so cancelling. ($elapsed_sec)");
array_push($pending_cancellations, $active_package->ID);
}
}
if ($active_package != null) {
if ((($active_package->Status == DUP_PRO_PackageStatus::AFTER_SCAN) || ($active_package->Status == DUP_PRO_PackageStatus::PRE_PROCESS)) && ($global->clientside_kickoff == false)) {
if ($active_package->timer_start == -1) {
$active_package->timer_start = DUP_PRO_U::getMicrotime();
$active_package->save();
}
$current_time = DUP_PRO_U::getMicrotime();
$elapsed_sec = $current_time - $active_package->timer_start;
if ($elapsed_sec > 75) {
DUP_PRO_LOG::trace("*** STUCK");
DUP_PRO_Log::open($active_package->NameHash);
$error_text = DUP_PRO_U::__('Communication to AJAX is blocked.');
$system_global = DUP_PRO_System_Global_Entity::get_instance();
$notification = true;
// notify if ajax setup is OK
if(DUP_PRO_U::is_ssl())
{
if($global->ajax_protocol == 'http')
{
$fix_text = DUP_PRO_U::__('The Plugin is configured for HTTP, but site is HTTPS. Click button to fix this issue.');
$system_global->add_recommended_quick_fix($error_text, $fix_text, 'special:{stuck_5percent_pending_fix:1}');
$notification = false;
}
}
else
{
if($global->ajax_protocol == 'https')
{
$fix_text = DUP_PRO_U::__('The Plugin is configured for the secure (SSL) admin-ajax protocol. Click button to fix this issue.');
$system_global->add_recommended_quick_fix($error_text, $fix_text, 'special:{stuck_5percent_pending_fix:1}');
$notification = false;
}
}
if($global->ajax_protocol == 'custom')
{
if(!DUP_PRO_U::urlExists($global->custom_ajax_url)) {
$fix_text = DUP_PRO_U::__('The Plugin is configured for the wrong admin-ajax URL. Click button to fix this issue.');
$system_global->add_recommended_quick_fix($error_text, $fix_text, 'special:{stuck_5percent_pending_fix:1}');
$notification = false;
}
}
if($notification)
{
$fix_text = sprintf("%s <a href='http://snapcreek.com/duplicator/docs/faqs-tech/#faq-package-100-q' target='_blank'>%s</a>", DUP_PRO_U::__('See FAQ:'), DUP_PRO_U::__('Why is the package build stuck at 5%?'));
$system_global->add_recommended_text_fix($error_text, $fix_text);
}
$system_global->save();
$log_fix_test = $fix_text;
if(stripos($log_fix_test, 'button') !== false) {
$log_fix_test .= DUP_PRO_U::__('. Button is on Packages screen.');
}
$message = DUP_PRO_U::__("$error_text **RECOMMENDATION: $log_fix_test.");
DUP_PRO_LOG::trace($message);
do_action('duplicator_pro_package_before_set_status' , $active_package , DUP_PRO_PackageStatus::ERROR);
$active_package->Status = DUP_PRO_PackageStatus::ERROR;
$active_package->save();
do_action('duplicator_pro_package_after_set_status' , $active_package , DUP_PRO_PackageStatus::ERROR);
if ($active_package->schedule_id != -1) {
add_action('plugins_loaded', array($active_package, 'post_scheduled_build_failure'));
}
DUP_PRO_Log::error($message, $message, false);
}
}
}
}
}
public static function kick_off_worker($run_only_if_client = false)
{
/* @var $global DUP_PRO_Global_Entity */
$global = DUP_PRO_Global_Entity::get_instance();
if (!$run_only_if_client || $global->clientside_kickoff) {
$calling_function_name = DupProSnapLibUtil::getCallingFunctionName();
DUP_PRO_LOG::trace("Kicking off worker process as requested by $calling_function_name");
$custom_url = strtolower($global->custom_ajax_url);
if ($global->ajax_protocol == 'custom') {
if (DUP_PRO_STR::startsWith($custom_url, 'http')) {
$ajax_url = $custom_url;
} else {
// Revert to http standard if they don't have the url correct
$ajax_url = admin_url('admin-ajax.php', 'http');
DUP_PRO_LOG::trace("Even though custom ajax url configured, incorrect url set so reverting to $ajax_url");
}
} else {
$ajax_url = admin_url('admin-ajax.php', $global->ajax_protocol);
}
DUP_PRO_LOG::trace("Attempting to use ajax url $ajax_url");
if ($global->clientside_kickoff) {
add_action('wp_enqueue_scripts', 'DUP_PRO_Package_Runner::add_kickoff_worker_javascript');
add_action('admin_enqueue_scripts', 'DUP_PRO_Package_Runner::add_kickoff_worker_javascript');
} else {
// Server-side kickoff
$ajax_url = DupProSnapLibURLU::appendQueryValue($ajax_url, 'action', 'duplicator_pro_process_worker');
$ajax_url = DupProSnapLibURLU::appendQueryValue($ajax_url, 'now', time());
// $duplicator_pro_process_worker_nonce = wp_create_nonce('duplicator_pro_process_worker');
//require_once(ABSPATH.'wp-includes/pluggable.php');
//$ajax_url = wp_nonce_url($ajax_url, 'duplicator_pro_process_worker', 'nonce');
/* @var $global DUP_PRO_Global_Entity */
DUP_PRO_LOG::trace('KICKOFF: Server Side');
if ($global->basic_auth_enabled) {
$sglobal = DUP_PRO_Secure_Global_Entity::getInstance();
$args = array('blocking' => false, 'headers' => array('Authorization' => 'Basic ' . base64_encode($global->basic_auth_user . ':' . $sglobal->basic_auth_password)));
} else {
$args = array('blocking' => false);
}
if ($global->server_kick_off_sslverify) {
$args['sslverify'] = true;
} else {
$args['sslverify'] = false;
}
wp_remote_get($ajax_url, $args);
}
DUP_PRO_LOG::trace("after sent kickoff request");
}
}
// Executed by cron
public static function process()
{
if (!defined('WP_MAX_MEMORY_LIMIT')) {
define('WP_MAX_MEMORY_LIMIT', '512M');
}
if (DupProSnapLibUtil::wp_is_ini_value_changeable('memory_limit'))
@ini_set('memory_limit', WP_MAX_MEMORY_LIMIT);
@set_time_limit(7200);
@ignore_user_abort(true);
if (DupProSnapLibUtil::wp_is_ini_value_changeable('pcre.backtrack_limit'))
@ini_set( 'pcre.backtrack_limit', PHP_INT_MAX );
if (DupProSnapLibUtil::wp_is_ini_value_changeable('default_socket_timeout'))
@ini_set('default_socket_timeout', 7200); // 2 Hours
/* @var $global DUP_PRO_Global_Entity */
$global = DUP_PRO_Global_Entity::get_instance();
if ($global->clientside_kickoff) {
DUP_PRO_LOG::trace("PROCESS: From client");
session_write_close();
} else {
DUP_PRO_LOG::trace("PROCESS: From server");
}
///* @var $global DUP_PRO_Global_Entity */
$global = DUP_PRO_Global_Entity::get_instance();
// Only attempt to process schedules if manual isn't running
if ($global->lock_mode == DUP_PRO_Thread_Lock_Mode::Flock) {
$locking_file = fopen(DUP_PRO_Constants::$LOCKING_FILE_FILENAME, 'c+');
} else {
$locking_file = true;
}
if ($locking_file != false) {
if ($global->lock_mode == DUP_PRO_Thread_Lock_Mode::Flock) {
$acquired_lock = (flock($locking_file, LOCK_EX | LOCK_NB) != false);
if ($acquired_lock) {
DUP_PRO_LOG::trace("File lock acquired ".$locking_file);
} else {
DUP_PRO_LOG::trace("File lock denied ".$locking_file);
}
} else {
$acquired_lock = DUP_PRO_U::getSqlLock();
}
if ($acquired_lock) {
self::process_schedules();
$package = DUP_PRO_Package::get_next_active_package();
/* @var $package DUP_PRO_Package */
if ($package != null) {
DUP_PRO_U::initStorageDirectory();
$dup_tests = self::get_requirements_tests();
if ($dup_tests['Success'] == true) {
$start_time = time();
DUP_PRO_LOG::trace("PACKAGE $package->ID:PROCESSING");
ignore_user_abort(true);
if ($package->Status < DUP_PRO_PackageStatus::AFTER_SCAN) {
// Scan step built into package build - used by schedules - NOT manual build where scan is done in web service.
DUP_PRO_LOG::trace("PACKAGE $package->ID:SCANNING");
//After scanner runs. Save FilterInfo (unreadable, warnings, globals etc)
$package->create_scan_report();
$package->update();
//del if($package->Archive->ScanStatus == DUP_PRO_Archive::ScanStatusComplete){
$dupe_package = DUP_PRO_Package::get_by_id($package->ID);
$dupe_package->set_status(DUP_PRO_PackageStatus::AFTER_SCAN);
//del }
$end_time = time();
$scan_time = $end_time - $start_time;
//del $end_time = DUP_PRO_U::getMicrotime();
//
// $scan_time = $end_time - $package->Archive->ScanTimeStart;
DUP_PRO_LOG::trace("SCAN TIME=$scan_time seconds");
} else if ($package->Status < DUP_PRO_PackageStatus::COPIEDPACKAGE) {
DUP_PRO_LOG::trace("PACKAGE $package->ID:BUILDING");
$package->run_build();
$end_time = time();
$build_time = $end_time - $start_time;
DUP_PRO_LOG::trace("BUILD TIME=$build_time seconds");
} else if ($package->Status < DUP_PRO_PackageStatus::COMPLETE) {
DUP_PRO_LOG::trace("PACKAGE $package->ID:STORAGE PROCESSING");
$package->set_status(DUP_PRO_PackageStatus::STORAGE_PROCESSING);
$package->process_storages();
$end_time = time();
$build_time = $end_time - $start_time;
DUP_PRO_LOG::trace("STORAGE CHUNK PROCESSING TIME=$build_time seconds");
if ($package->Status == DUP_PRO_PackageStatus::COMPLETE) {
DUP_PRO_LOG::trace("PACKAGE $package->ID COMPLETE");
} else if ($package->Status == DUP_PRO_PackageStatus::ERROR) {
DUP_PRO_LOG::trace("PACKAGE $package->ID IN ERROR STATE");
}
}
ignore_user_abort(false);
} else {
DUP_PRO_Log::open($package->NameHash);
DUP_PRO_Log::error(DUP_PRO_U::__('Requirements Failed'), print_r($dup_tests, true), false);
DUP_PRO_LOG::traceError('Requirements didn\'t pass so can\'t perform backup!');
do_action('duplicator_pro_package_before_set_status' , $package , DUP_PRO_PackageStatus::REQUIREMENTS_FAILED);
$package->Status = DUP_PRO_PackageStatus::REQUIREMENTS_FAILED;
$package->update();
do_action('duplicator_pro_package_after_set_status' , $package , DUP_PRO_PackageStatus::REQUIREMENTS_FAILED);
}
}
//$kick_off_worker = (DUP_PRO_Package::get_next_active_package() != null);
$kick_off_worker = DUP_PRO_Package::is_active_package_present();
if ($global->lock_mode == DUP_PRO_Thread_Lock_Mode::Flock) {
DUP_PRO_LOG::trace("File lock released");
if (!flock($locking_file, LOCK_UN)) {
DUP_PRO_LOG::trace("File lock cant release ".$locking_file);
} else {
DUP_PRO_LOG::trace("File lock released ".$locking_file);
}
fclose($locking_file);
} else {
DUP_PRO_U::releaseSqlLock();
}
if ($kick_off_worker) {
self::kick_off_worker();
}
} else {
// File locked so another cron already running so just skip
DUP_PRO_LOG::trace("File locked so skipping");
}
} else {
DUP_PRO_LOG::trace("Problem opening locking file so auto switching to SQL lock mode");
$global->lock_mode = DUP_PRO_Thread_Lock_Mode::SQL_Lock;
$global->save();
exit();
}
}
public static function get_requirements_tests()
{
$dup_tests = DUP_PRO_Server::getRequirments();
if ($dup_tests['Success'] != true) {
DUP_PRO_LOG::traceObject('requirements', $dup_tests);
}
return $dup_tests;
}
public static function calculate_earliest_schedule_run_time()
{
$next_run_time = PHP_INT_MAX;
$schedules = DUP_PRO_Schedule_Entity::get_active();
foreach ($schedules as $schedule) {
/* @var $schedule DUP_PRO_Schedule_Entity */
if ($schedule->next_run_time == -1) {
$schedule->next_run_time = $schedule->get_next_run_time();
$schedule->save();
}
if ($schedule->next_run_time < $next_run_time) {
$next_run_time = $schedule->next_run_time;
}
}
if ($next_run_time == PHP_INT_MAX) {
$next_run_time = -1;
}
return $next_run_time;
}
public static function process_schedules()
{
// Hack fix - observed issue on a machine where schedule process bombs
$next_run_time = self::calculate_earliest_schedule_run_time();
if ($next_run_time != -1 && ($next_run_time <= time())) {
$schedules = DUP_PRO_Schedule_Entity::get_active();
foreach ($schedules as $schedule) {
/* @var $schedule DUP_PRO_Schedule_Entity */
$schedule->process();
}
}
}
}
}