ftp.class.php — UpdraftPlus: WP Backup & Migration Plugin 1.16.23

updraftplus / includes / ftp.class.php

updraftplus / includes Last commit date

ftp.class.php

240 lines

1	<?php
2
3	if (!defined('UPDRAFTPLUS_DIR')) die('No direct access allowed.');
4
5	/**
6	* Adapted from http://www.solutionbot.com/2009/01/02/php-ftp-class/
7	*/
8	class UpdraftPlus_ftp_wrapper {
9
10	private $conn_id;
11
12	private $host;
13
14	private $username;
15
16	private $password;
17
18	private $port;
19
20	public $timeout = 60;
21
22	public $passive = true;
23
24	public $system_type = '';
25
26	public $ssl = false;
27
28	public $use_server_certs = false;
29
30	public $disable_verify = true;
31
32	public $login_type = 'non-encrypted';
33
34	public function __construct($host, $username, $password, $port = 21) {
35	$this->host = $host;
36	$this->username = $username;
37	$this->password = $password;
38	$this->port = $port;
39	}
40
41	public function connect() {
42
43	$time_start = time();
44	$this->conn_id = ftp_connect($this->host, $this->port, 20);
45
46	if ($this->conn_id) $result = ftp_login($this->conn_id, $this->username, $this->password);
47
48	if (!empty($result)) {
49	ftp_set_option($this->conn_id, FTP_TIMEOUT_SEC, $this->timeout);
50	ftp_pasv($this->conn_id, $this->passive);
51	$this->system_type = ftp_systype($this->conn_id);
52	return true;
53	}
54
55	if (time() - $time_start > 19) {
56	global $updraftplus_admin;
57	if (isset($updraftplus_admin->logged) && is_array($updraftplus_admin->logged)) {
58	$updraftplus_admin->logged[] = sprintf(__('The %s connection timed out; if you entered the server correctly, then this is usually caused by a firewall blocking the connection - you should check with your web hosting company.', 'updraftplus'), 'FTP');
59	} else {
60	global $updraftplus;
61	$updraftplus->log(sprintf(__('The %s connection timed out; if you entered the server correctly, then this is usually caused by a firewall blocking the connection - you should check with your web hosting company.', 'updraftplus'), 'FTP'), 'error');
62	}
63	}
64
65	return false;
66	}
67
68	public function put($local_file_path, $remote_file_path, $mode = FTP_BINARY, $resume = false, $updraftplus = false) {
69
70	$file_size = filesize($local_file_path);
71
72	$existing_size = 0;
73	if ($resume) {
74	$existing_size = ftp_size($this->conn_id, $remote_file_path);
75	if ($existing_size <=0) {
76	$resume = false;
77	$existing_size = 0;
78	} else {
79	if (is_a($updraftplus, 'UpdraftPlus')) $updraftplus->log("File already exists at remote site: size $existing_size. Will attempt resumption.");
80	if ($existing_size >= $file_size) {
81	if (is_a($updraftplus, 'UpdraftPlus')) $updraftplus->log("File is apparently already completely uploaded");
82	return true;
83	}
84	}
85	}
86
87	// From here on, $file_size is only used for logging calculations. We want to avoid divsion by zero.
88	$file_size = max($file_size, 1);
89
90	if (!$fh = fopen($local_file_path, 'rb')) return false;
91	if ($existing_size) fseek($fh, $existing_size);
92
93	$ret = ftp_nb_fput($this->conn_id, $remote_file_path, $fh, $mode, $existing_size);
94
95	// $existing_size can now be re-purposed
96
97	while (FTP_MOREDATA == $ret) {
98	if (is_a($updraftplus, 'UpdraftPlus')) {
99	$new_size = ftell($fh);
100	$record_after = 524288;
101	if ($existing_size > 2097152) {
102	$record_after = ($existing_size > 4194304) ? 2097152 : 1048576;
103	}
104	if ($new_size - $existing_size > $record_after) {
105	$existing_size = $new_size;
106	$percent = round(100*$new_size/$file_size, 1);
107	$updraftplus->record_uploaded_chunk($percent, '', $local_file_path);
108	}
109	}
110	// Continue upload
111	$ret = ftp_nb_continue($this->conn_id);
112	}
113
114	fclose($fh);
115
116	if (FTP_FINISHED != $ret) {
117	if (is_a($updraftplus, 'UpdraftPlus')) $updraftplus->log("FTP upload: error ($ret)");
118	return false;
119	}
120
121	return true;
122
123	}
124
125	public function get($local_file_path, $remote_file_path, $mode = FTP_BINARY, $resume = false, $updraftplus = false) {
126
127	$file_last_size = 0;
128
129	if ($resume) {
130	if (!$fh = fopen($local_file_path, 'ab')) return false;
131	clearstatcache($local_file_path);// phpcs:ignore PHPCompatibility.FunctionUse.NewFunctionParameters.clearstatcache_clear_realpath_cacheFound -- The function clearstatcache() does not have a parameter "clear_realpath_cache" in PHP version 5.2 or earlier
132	$file_last_size = filesize($local_file_path);
133	} else {
134	if (!$fh = fopen($local_file_path, 'wb')) return false;
135	}
136
137	$ret = ftp_nb_fget($this->conn_id, $fh, $remote_file_path, $mode, $file_last_size);
138
139	if (false == $ret) return false;
140
141	while (FTP_MOREDATA == $ret) {
142
143	if ($updraftplus) {
144	$file_now_size = filesize($local_file_path);
145	if ($file_now_size - $file_last_size > 524288) {
146	$updraftplus->log("FTP fetch: file size is now: ".sprintf("%0.2f", filesize($local_file_path)/1048576)." Mb");
147	$file_last_size = $file_now_size;
148	}
149	clearstatcache($local_file_path);// phpcs:ignore PHPCompatibility.FunctionUse.NewFunctionParameters.clearstatcache_clear_realpath_cacheFound -- The function clearstatcache() does not have a parameter "clear_realpath_cache" in PHP version 5.2 or earlier
150	}
151
152	$ret = ftp_nb_continue($this->conn_id);
153	}
154
155	fclose($fh);
156
157	if (FTP_FINISHED == $ret) {
158	if ($updraftplus) $updraftplus->log("FTP fetch: fetch complete");
159	return true;
160	} else {
161	if ($updraftplus) $updraftplus->log("FTP fetch: fetch failed");
162	return false;
163	}
164
165	}
166
167	public function chmod($permissions, $remote_filename) {
168	if ($this->is_octal($permissions)) {
169	$result = ftp_chmod($this->conn_id, $permissions, $remote_filename);
170	if ($result) {
171	return true;
172	} else {
173	return false;
174	}
175	} else {
176	throw new Exception('$permissions must be an octal number');
177	}
178	}
179
180	public function chdir($directory) {
181	ftp_chdir($this->conn_id, $directory);
182	}
183
184	public function delete($remote_file_path) {
185	if (ftp_delete($this->conn_id, $remote_file_path)) {
186	return true;
187	} else {
188	return false;
189	}
190	}
191
192	public function make_dir($directory) {
193	if (ftp_mkdir($this->conn_id, $directory)) {
194	return true;
195	} else {
196	return false;
197	}
198	}
199
200	public function rename($old_name, $new_name) {
201	if (ftp_rename($this->conn_id, $old_name, $new_name)) {
202	return true;
203	} else {
204	return false;
205	}
206	}
207
208	public function remove_dir($directory) {
209	if (ftp_rmdir($this->conn_id, $directory)) {
210	return true;
211	} else {
212	return false;
213	}
214	}
215
216	public function dir_list($directory) {
217	return ftp_nlist($this->conn_id, $directory);
218	}
219
220	public function cdup() {
221	ftp_cdup($this->conn_id);
222	}
223
224	public function size($f) {
225	return ftp_size($this->conn_id, $f);
226	}
227
228	public function current_dir() {
229	return ftp_pwd($this->conn_id);
230	}
231
232	private function is_octal($i) {
233	return decoct(octdec($i)) == $i;
234	}
235
236	public function __destruct() {
237	if ($this->conn_id) ftp_close($this->conn_id);
238	}
239	}
240