class-job-scheduler.php — UpdraftPlus: WP Backup & Migration Plugin 1.26.4

updraftplus / includes / class-job-scheduler.php

updraftplus / includes Last commit date

class-job-scheduler.php

219 lines

1	<?php
2
3	if (!defined('UPDRAFTPLUS_DIR')) die('No access.');
4
5	/**
6	* A class for scheduling-related code.
7	* N.B. This class began life Nov 2018; it is not guaranteed to contain all scheduling-related code. The variables used have also generally remained in the UpdraftPlus class.
8	*/
9	class UpdraftPlus_Job_Scheduler {
10
11	/**
12	* This function is purely for timing - we just want to know the maximum run-time; not whether we have achieved anything during it. It will also run a check on whether the resumption interval is being approached.
13	*/
14	public static function record_still_alive() {
15
16	global $updraftplus;
17
18	// Update the record of maximum detected runtime on each run
19	$time_passed = $updraftplus->jobdata_get('run_times');
20	if (!is_array($time_passed)) $time_passed = array();
21
22	$time_this_run = microtime(true)-$updraftplus->opened_log_time;
23	$time_passed[$updraftplus->current_resumption] = $time_this_run;
24	$updraftplus->jobdata_set('run_times', $time_passed);
25
26	$resume_interval = $updraftplus->jobdata_get('resume_interval');
27	if ($time_this_run + 30 > $resume_interval) {
28	$new_interval = ceil($time_this_run + 30);
29	set_site_transient('updraft_initial_resume_interval', (int) $new_interval, 8*86400);
30	$updraftplus->log("The time we have been running (".round($time_this_run, 1).") is approaching the resumption interval ($resume_interval) - increasing resumption interval to $new_interval");
31	$updraftplus->jobdata_set('resume_interval', $new_interval);
32	}
33
34	}
35
36	/**
37	* This method helps with efficient scheduling
38	*/
39	public static function reschedule_if_needed() {
40
41	global $updraftplus;
42
43	// If nothing is scheduled, then no re-scheduling is needed, so return
44	if (empty($updraftplus->newresumption_scheduled)) return;
45
46	$time_away = $updraftplus->newresumption_scheduled - time();
47
48	// 45 is chosen because it is 15 seconds more than what is used to detect recent activity on files (file mod times). (If we use exactly the same, then it's more possible to slightly miss each other)
49	if ($time_away > 1 && $time_away <= 45) {
50	$updraftplus->log('The scheduled resumption is within 45 seconds - will reschedule');
51	// Increase interval generally by 45 seconds, on the assumption that our prior estimates were innaccurate (i.e. not just 45 seconds this time)
52	self::increase_resume_and_reschedule(45);
53	}
54	}
55
56	/**
57	* Indicate that something useful happened. Calling this at appropriate times is an important part of scheduling decisions.
58	*/
59	public static function something_useful_happened() {
60
61	global $updraftplus;
62
63	self::record_still_alive();
64
65	if (!$updraftplus->something_useful_happened) {
66
67	// Update the record of when something useful happened
68	$useful_checkins = $updraftplus->jobdata_get('useful_checkins');
69	if (!is_array($useful_checkins)) $useful_checkins = array();
70	if (!in_array($updraftplus->current_resumption, $useful_checkins)) {
71	$useful_checkins[] = $updraftplus->current_resumption;
72	$updraftplus->jobdata_set('useful_checkins', $useful_checkins);
73	}
74
75	}
76
77	$updraftplus->something_useful_happened = true;
78
79	$clone_job = $updraftplus->jobdata_get('clone_job');
80
81	if (!empty($clone_job)) {
82	static $last_call = false;
83
84	// Check we haven't yet made a call or that 15 minutes has passed before we make another call
85	if (!$last_call \|\| time() - $last_call > 900) {
86	$last_call = time();
87	$clone_id = $updraftplus->jobdata_get('clone_id');
88	$secret_token = $updraftplus->jobdata_get('secret_token');
89	$log_data = $updraftplus->get_last_log_chunk($updraftplus->file_nonce);
90	$log_contents = isset($log_data['log_contents']) ? $log_data['log_contents'] : '';
91	$first_byte = isset($log_data['first_byte']) ? $log_data['first_byte'] : 0;
92	$response = $updraftplus->get_updraftplus_clone()->backup_checkin(array('clone_id' => $clone_id, 'secret_token' => $secret_token, 'first_byte' => $first_byte, 'log_contents' => $log_contents));
93	if (!isset($response['status']) \|\| 'success' != $response['status']) {
94	$updraftplus->log("UpdraftClone backup check-in failed.");
95	} else {
96	$updraftplus->log("UpdraftClone backup check-in made successfully.");
97	}
98	}
99	}
100
101	$updraft_dir = $updraftplus->backups_dir_location();
102	if (file_exists($updraft_dir.'/deleteflag-'.$updraftplus->nonce.'.txt')) {
103	$updraftplus->log("User request for abort: backup job will be immediately halted");
104	@unlink($updraft_dir.'/deleteflag-'.$updraftplus->nonce.'.txt');// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise because of the method.
105	$updraftplus->backup_finish(true, true, true);
106	die;
107	}
108
109	if ($updraftplus->current_resumption >= 9 && false == $updraftplus->newresumption_scheduled) {
110	$updraftplus->log("This is resumption ".$updraftplus->current_resumption.", but meaningful activity is still taking place; so a new one will be scheduled");
111	// We just use max here to make sure we get a number at all
112	$resume_interval = max($updraftplus->jobdata_get('resume_interval'), 75);
113	// Don't consult the minimum here
114	// if (!is_numeric($resume_interval) \|\| $resume_interval<300) { $resume_interval = 300; }
115	$schedule_for = time()+$resume_interval;
116	$updraftplus->newresumption_scheduled = $schedule_for;
117	wp_schedule_single_event($schedule_for, 'updraft_backup_resume', array($updraftplus->current_resumption + 1, $updraftplus->nonce));
118	} else {
119	self::reschedule_if_needed();
120	}
121	}
122
123	/**
124	* Reschedule the next resumption for the specified amount of time in the future
125	*
126	* @uses wp_schedule_single_event()
127	*
128	* @param Integer $how_far_ahead - a number of seconds
129	*/
130	public static function reschedule($how_far_ahead) {
131
132	global $updraftplus;
133
134	// Reschedule - remove presently scheduled event
135	$next_resumption = $updraftplus->current_resumption + 1;
136	wp_clear_scheduled_hook('updraft_backup_resume', array($next_resumption, $updraftplus->nonce));
137	// Add new event
138	// This next line may be too cautious; but until 14-Aug-2014, it was 300.
139	// Update 20-Mar-2015 - lowered from 180 to 120
140	// Update 03-Aug-2018 - lowered from 120 to 100
141	// Update 09-Oct-2020 - lowered from 100 to 60
142	if ($how_far_ahead < 60) $how_far_ahead = 60;
143	$schedule_for = time() + $how_far_ahead;
144	$updraftplus->log("Rescheduling resumption $next_resumption: moving to $how_far_ahead seconds from now ($schedule_for)");
145	wp_schedule_single_event($schedule_for, 'updraft_backup_resume', array($next_resumption, $updraftplus->nonce));
146	$updraftplus->newresumption_scheduled = $schedule_for;
147	}
148
149	/**
150	* Terminate a backup run because other activity on the backup has been detected
151	*
152	* @uses die()
153	*
154	* @param String $file - Indicate the file whose recent modification is indicative of activity
155	* @param Integer $time_now - The epoch time at which the detection took place
156	* @param Integer $time_mod - The epoch time at which the file was modified
157	* @param Boolean $increase_resumption - Whether or not to increase the resumption interval
158	*/
159	public static function terminate_due_to_activity($file, $time_now, $time_mod, $increase_resumption = true) {
160
161	global $updraftplus;
162
163	// We check-in, to avoid 'no check in last time!' detectors firing.
164	self::record_still_alive();
165
166	// Log
167	$file_size = file_exists($file) ? round(filesize($file)/1024, 1). 'KB' : 'n/a';
168	$updraftplus->log("Terminate: ".basename($file)." exists with activity within the last 30 seconds (time_mod=$time_mod, time_now=$time_now, diff=".(floor($time_now-$time_mod)).", size=$file_size). This likely means that another UpdraftPlus run is at work; so we will exit.");
169
170	$increase_by = $increase_resumption ? 120 : 0;
171	self::increase_resume_and_reschedule($increase_by, true);
172
173	// Die, unless there was a deliberate over-ride (for development purposes)
174	if (!defined('UPDRAFTPLUS_ALLOW_RECENT_ACTIVITY') \|\| !UPDRAFTPLUS_ALLOW_RECENT_ACTIVITY) die;
175	}
176
177	/**
178	* Increase the resumption interval and reschedule the next resumption
179	*
180	* @uses self::reschedule()
181	*
182	* @param Integer $howmuch - how much to add to the existing resumption interval
183	* @param Boolean $due_to_overlap - setting this changes the strategy for calculating the next resumption; it indicates that the reason for an increase is because of recent activity detection
184	*/
185	private static function increase_resume_and_reschedule($howmuch = 120, $due_to_overlap = false) {
186
187	global $updraftplus;
188
189	$resume_interval = max((int) $updraftplus->jobdata_get('resume_interval'), (0 === $howmuch) ? 120 : 300);
190
191	if (empty($updraftplus->newresumption_scheduled) && $due_to_overlap) {
192	$updraftplus->log('A new resumption will be scheduled to prevent the job ending');
193	}
194
195	$new_resume = $resume_interval + $howmuch;
196	// It may be that we're increasing for the second (or more) time during a run, and that we already know that the new value will be insufficient, and can be increased
197	if ($updraftplus->opened_log_time > 100 && microtime(true)-$updraftplus->opened_log_time > $new_resume) {
198	$new_resume = ceil(microtime(true)-$updraftplus->opened_log_time)+45;
199	$howmuch = $new_resume-$resume_interval;
200	}
201
202	// This used to be always $new_resume, until 14-Aug-2014. However, people who have very long-running processes can end up with very long times between resumptions as a result.
203	// Actually, let's not try this yet. I think it is safe, but think there is a more conservative solution available.
204	// $how_far_ahead = min($new_resume, 600);
205	// Nov 2018 - scheduling the next resumption unnecessarily-far-in-the-future after an overlap is still occurring, so, we're adjusting this to have a maximum value in that particular case
206	$how_far_ahead = $due_to_overlap ? min($new_resume, 900) : $new_resume;
207
208	// If it is very long-running, then that would normally be known soon.
209	// If the interval is already 12 minutes or more, then try the next resumption 10 minutes from now (i.e. sooner than it would have been). Thus, we are guaranteed to get at least 24 minutes of processing in the first 34.
210	if ($updraftplus->current_resumption <= 1 && $new_resume > 720) $how_far_ahead = 600;
211
212	if (!empty($updraftplus->newresumption_scheduled) \|\| $due_to_overlap) self::reschedule($how_far_ahead);
213
214	$updraftplus->jobdata_set('resume_interval', $new_resume);
215
216	$updraftplus->log("To decrease the likelihood of overlaps, increasing resumption interval to: $resume_interval + $howmuch = $new_resume");
217	}
218	}
219