1 | <?php |
||
13 | class Site_Size { |
||
14 | |||
15 | private $size = 0; |
||
16 | private $type = ''; |
||
17 | private $excludes = array(); |
||
18 | |||
19 | /** |
||
20 | * Constructor |
||
21 | * |
||
22 | * Set up some initial conditions including whether we want to calculate the |
||
23 | * size of the database, files or both and whether to exclude any files from |
||
24 | * the file size calculation. |
||
25 | * |
||
26 | * @param string $type Whether to calculate the size of the database, files |
||
27 | * or both. Should be one of 'file', 'database' or 'complete' |
||
28 | * @param array $excludes An array of exclude rules |
||
|
|||
29 | */ |
||
30 | public function __construct( $type = 'complete', Excludes $excludes = null ) { |
||
34 | |||
35 | /** |
||
36 | * Calculate the size total size of the database + files. |
||
37 | * |
||
38 | * Doesn't account for any compression that would be gained by zipping. |
||
39 | * |
||
40 | * @return string |
||
41 | */ |
||
42 | public function get_site_size() { |
||
43 | |||
44 | if ( $this->size ) { |
||
45 | return $this->size; |
||
46 | } |
||
47 | |||
48 | $size = 0; |
||
49 | |||
50 | // Include database size except for file only schedule. |
||
51 | if ( 'file' !== $this->type ) { |
||
52 | |||
53 | $size = (int) get_transient( 'hmbkp_database_size' ); |
||
54 | |||
55 | if ( ! $size ) { |
||
56 | |||
57 | global $wpdb; |
||
58 | |||
59 | $tables = $wpdb->get_results( 'SHOW TABLE STATUS FROM `' . DB_NAME . '`', ARRAY_A ); |
||
60 | |||
61 | foreach ( $tables as $table ) { |
||
62 | $size += (float) $table['Data_length']; |
||
63 | } |
||
64 | |||
65 | set_transient( 'hmbkp_database_size', $size, WEEK_IN_SECONDS ); |
||
66 | } |
||
67 | } |
||
68 | |||
69 | // Include total size of dirs/files except for database only schedule. |
||
70 | if ( 'database' !== $this->type ) { |
||
71 | |||
72 | $root = new \SplFileInfo( Path::get_root() ); |
||
73 | $size += $this->filesize( $root ); |
||
74 | |||
75 | } |
||
76 | |||
77 | $this->size = $size; |
||
78 | |||
79 | return $size; |
||
80 | |||
81 | } |
||
82 | |||
83 | /** |
||
84 | * Get the site size formatted |
||
85 | * |
||
86 | * @see size_format |
||
87 | * |
||
88 | * @return string |
||
89 | */ |
||
90 | public function get_formatted_site_size() { |
||
93 | |||
94 | /** |
||
95 | * Whether the total filesize is being calculated |
||
96 | * |
||
97 | * @return bool |
||
98 | */ |
||
99 | public static function is_site_size_being_calculated() { |
||
102 | |||
103 | /** |
||
104 | * Whether the total filesize is cached |
||
105 | * |
||
106 | * @return bool |
||
107 | */ |
||
108 | public function is_site_size_cached() { |
||
109 | return (bool) $this->get_cached_filesizes(); |
||
110 | } |
||
111 | |||
112 | /** |
||
113 | * Recursively scans a directory to calculate the total filesize |
||
114 | * |
||
115 | * Locks should be set by the caller with `set_transient( 'hmbkp_directory_filesizes_running', true, HOUR_IN_SECONDS );` |
||
116 | * |
||
117 | * @return array $directory_sizes An array of directory paths => filesize sum of all files in directory |
||
118 | */ |
||
119 | public function recursive_filesize_scanner() { |
||
164 | |||
165 | /** |
||
166 | * Get the total filesize for a given file or directory. Aware of exclusions. |
||
167 | * |
||
168 | * If $file is a file then return the result of `filesize()` or 0 if it's excluded. |
||
169 | * If $file is a directory then recursively calculate the size without |
||
170 | * the size of excluded files/directories. |
||
171 | * |
||
172 | * @param \SplFileInfo $file The file or directory you want to know the size of. |
||
173 | * |
||
174 | * @return int The total filesize of the file or directory without |
||
175 | * the size of excluded files/directories. |
||
176 | */ |
||
177 | public function filesize( \SplFileInfo $file ) { |
||
178 | |||
179 | // Skip missing or unreadable files. |
||
180 | if ( ! file_exists( $file->getPathname() ) || ! $file->getRealpath() || ! $file->isReadable() ) { |
||
181 | return 0; |
||
182 | } |
||
183 | |||
184 | // If it's a file then return its filesize or 0 if it's excluded. |
||
185 | if ( $file->isFile() ) { |
||
186 | |||
187 | if ( $this->excludes && $this->excludes->is_file_excluded( $file ) ) { |
||
188 | return 0; |
||
189 | } else { |
||
190 | return $file->getSize(); |
||
191 | } |
||
192 | } |
||
193 | |||
194 | // If it's a directory then pull it from the cached filesize array. |
||
195 | if ( $file->isDir() ) { |
||
196 | return $this->directory_filesize( $file ); |
||
197 | } |
||
198 | } |
||
199 | |||
200 | public function directory_filesize( \SplFileInfo $file ) { |
||
201 | |||
202 | // For performance reasons we cache the root. |
||
203 | if ( $file->getRealPath() === PATH::get_root() && $this->excludes ) { |
||
204 | |||
205 | $directory_sizes = get_transient( 'hmbkp_root_size' ); |
||
206 | |||
207 | if ( $directory_sizes ) { |
||
208 | return (int) $directory_sizes; |
||
209 | } |
||
210 | } |
||
211 | |||
212 | // If we haven't calculated the site size yet then kick it off in a thread. |
||
213 | $directory_sizes = $this->get_cached_filesizes(); |
||
214 | |||
215 | if ( ! is_array( $directory_sizes ) ) { |
||
216 | $this->rebuild_directory_filesizes(); |
||
217 | |||
218 | // Intentionally return null so the caller can tell that the size is being calculated. |
||
219 | return null; |
||
220 | } |
||
221 | |||
222 | /* |
||
223 | * Ensure we only include files in the current path, the filepaths are stored in keys |
||
224 | * so we need to flip for use with preg_grep. |
||
225 | */ |
||
226 | $directory_sizes = array_flip( preg_grep( '(' . wp_normalize_path( $file->getRealPath() ) . ')', array_flip( $directory_sizes ) ) ); |
||
227 | |||
228 | if ( $this->excludes ) { |
||
229 | |||
230 | $excludes = implode( '|', $this->excludes->get_excludes_for_regex() ); |
||
231 | |||
232 | if ( $excludes ) { |
||
233 | // Use PREG_GREP_INVERT to remove any filepaths which match an exclude rule |
||
234 | $directory_sizes = array_flip( preg_grep( '(' . $excludes . ')', array_flip( $directory_sizes ), PREG_GREP_INVERT ) ); |
||
235 | } |
||
236 | } |
||
237 | |||
238 | $directory_sizes = absint( array_sum( $directory_sizes ) ); |
||
239 | |||
240 | // For performance reasons we cache the root. |
||
241 | if ( $file->getRealPath() === PATH::get_root() && $this->excludes ) { |
||
242 | set_transient( 'hmbkp_root_size', $directory_sizes, DAY_IN_SECONDS ); |
||
243 | } |
||
244 | |||
245 | // Directory size is now just a sum of all files across all sub directories. |
||
246 | return (int) $directory_sizes; |
||
247 | |||
248 | } |
||
249 | |||
250 | public function rebuild_directory_filesizes() { |
||
264 | |||
265 | public function get_cached_filesizes( $max_age = WEEK_IN_SECONDS ) { |
||
266 | |||
267 | $cache = PATH::get_path() . '/.files'; |
||
281 | } |
||
282 |
This check looks for
@param
annotations where the type inferred by our type inference engine differs from the declared type.It makes a suggestion as to what type it considers more descriptive.
Most often this is a case of a parameter that can be null in addition to its declared types.