Total Complexity | 60 |
Total Lines | 420 |
Duplicated Lines | 0 % |
Changes | 16 | ||
Bugs | 9 | Features | 1 |
Complex classes like Xcloner_Scheduler often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Xcloner_Scheduler, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
3 | class Xcloner_Scheduler { |
||
4 | |||
5 | private $db; |
||
6 | private $scheduler_table = "xcloner_scheduler"; |
||
7 | |||
8 | private $xcloner_remote_storage; |
||
9 | private $archive_system; |
||
10 | private $xcloner_database; |
||
11 | private $xcloner_settings; |
||
12 | private $logger; |
||
13 | private $xcloner_file_system; |
||
14 | private $xcloner_encryption; |
||
15 | |||
16 | private $allowed_schedules = array("hourly", "twicedaily", "daily", "weekly", "monthly"); |
||
17 | |||
18 | /*public function __call($method, $args) { |
||
19 | echo "$method is not defined"; |
||
20 | }*/ |
||
21 | |||
22 | public function __construct(Xcloner $xcloner_container) { |
||
23 | global $wpdb; |
||
24 | |||
25 | $this->db = $wpdb; |
||
26 | $wpdb->show_errors = false; |
||
27 | |||
28 | $this->xcloner_container = $xcloner_container; |
||
|
|||
29 | $this->xcloner_settings = $this->xcloner_container->get_xcloner_settings(); |
||
30 | |||
31 | $this->scheduler_table = $this->db->prefix.$this->scheduler_table; |
||
32 | } |
||
33 | |||
34 | private function get_xcloner_container() { |
||
35 | return $this->xcloner_container; |
||
36 | } |
||
37 | |||
38 | private function set_xcloner_container(Xcloner $container) { |
||
39 | $this->xcloner_container = $container; |
||
40 | } |
||
41 | |||
42 | public function get_scheduler_list($return_only_enabled = 0) { |
||
43 | $list = $this->db->get_results("SELECT * FROM ".$this->scheduler_table); |
||
44 | |||
45 | if ($return_only_enabled) { |
||
46 | $new_list = array(); |
||
47 | |||
48 | foreach ($list as $res) { |
||
49 | if ($res->status) { |
||
50 | $res->next_run_time = wp_next_scheduled('xcloner_scheduler_'.$res->id, array($res->id)) + (get_option('gmt_offset') * HOUR_IN_SECONDS); |
||
51 | $new_list[] = $res; |
||
52 | } |
||
53 | } |
||
54 | $list = $new_list; |
||
55 | } |
||
56 | |||
57 | return $list; |
||
58 | } |
||
59 | |||
60 | public function get_next_run_schedule( ) { |
||
61 | $list = $this->get_scheduler_list($return_only_enabled = 1); |
||
62 | |||
63 | return $list; |
||
64 | } |
||
65 | |||
66 | public function get_schedule_by_id_object($id) { |
||
67 | $data = $this->db->get_row("SELECT * FROM ".$this->scheduler_table." WHERE id=".$id); |
||
68 | |||
69 | return $data; |
||
70 | } |
||
71 | |||
72 | public function get_schedule_by_id($id) { |
||
73 | $data = $this->db->get_row("SELECT * FROM ".$this->scheduler_table." WHERE id=".$id, ARRAY_A); |
||
74 | |||
75 | if (!$data) { |
||
76 | return false; |
||
77 | } |
||
78 | |||
79 | $params = json_decode($data['params']); |
||
80 | |||
81 | //print_r($params); |
||
82 | $data['params'] = ""; |
||
83 | $data['backup_params'] = $params->backup_params; |
||
84 | $data['table_params'] = json_encode($params->database); |
||
85 | $data['excluded_files'] = json_encode($params->excluded_files); |
||
86 | |||
87 | return $data; |
||
88 | } |
||
89 | |||
90 | public function delete_schedule_by_id($id) { |
||
91 | $hook = 'xcloner_scheduler_'.$id; |
||
92 | wp_clear_scheduled_hook($hook, array($id)); |
||
93 | |||
94 | $data = $this->db->delete($this->scheduler_table, array('id' => $id)); |
||
95 | |||
96 | return $data; |
||
97 | } |
||
98 | |||
99 | public function deactivate_wp_cron_hooks() { |
||
100 | $list = $this->get_scheduler_list(); |
||
101 | |||
102 | foreach ($list as $schedule) { |
||
103 | $hook = 'xcloner_scheduler_'.$schedule->id; |
||
104 | |||
105 | $timestamp = wp_next_scheduled($hook, array($schedule->id)); |
||
106 | wp_unschedule_event($timestamp, $hook, array($schedule->id)); |
||
107 | } |
||
108 | } |
||
109 | |||
110 | public function update_wp_cron_hooks() { |
||
111 | $list = $this->get_scheduler_list(); |
||
112 | |||
113 | foreach ($list as $schedule) { |
||
114 | $hook = 'xcloner_scheduler_'.$schedule->id; |
||
115 | |||
116 | //adding the xcloner_scheduler hook with xcloner_scheduler_callback callback |
||
117 | add_action($hook, array($this, 'xcloner_scheduler_callback'), 10, 1); |
||
118 | |||
119 | if (!wp_next_scheduled($hook, array($schedule->id)) and $schedule->status) { |
||
120 | |||
121 | if ($schedule->recurrence == "single") { |
||
122 | wp_schedule_single_event(strtotime($schedule->start_at), $hook, array($schedule->id)); |
||
123 | } else { |
||
124 | wp_schedule_event(strtotime($schedule->start_at), $schedule->recurrence, $hook, array($schedule->id)); |
||
125 | } |
||
126 | |||
127 | } elseif (!$schedule->status) { |
||
128 | $timestamp = wp_next_scheduled($hook, array($schedule->id)); |
||
129 | wp_unschedule_event($timestamp, $hook, array($schedule->id)); |
||
130 | } |
||
131 | } |
||
132 | |||
133 | } |
||
134 | |||
135 | public function update_cron_hook($id) { |
||
136 | $schedule = $this->get_schedule_by_id_object($id); |
||
137 | $hook = 'xcloner_scheduler_'.$schedule->id; |
||
138 | |||
139 | $timestamp = wp_next_scheduled($hook, array($schedule->id)); |
||
140 | wp_unschedule_event($timestamp, $hook, array($schedule->id)); |
||
141 | |||
142 | if ($schedule->status) { |
||
143 | |||
144 | if ($schedule->recurrence == "single") { |
||
145 | wp_schedule_single_event(strtotime($schedule->start_at), $hook, array($schedule->id)); |
||
146 | } else { |
||
147 | wp_schedule_event(strtotime($schedule->start_at), $schedule->recurrence, $hook, array($schedule->id)); |
||
148 | } |
||
149 | |||
150 | } |
||
151 | } |
||
152 | |||
153 | public function disable_single_cron($schedule_id) { |
||
154 | $hook = 'xcloner_scheduler_'.$schedule_id; |
||
155 | $timestamp = wp_next_scheduled($hook, array($schedule_id)); |
||
156 | wp_unschedule_event($timestamp, $hook, array($schedule_id)); |
||
157 | |||
158 | $schedule['status'] = 0; |
||
159 | |||
160 | $update = $this->db->update( |
||
161 | $this->scheduler_table, |
||
162 | $schedule, |
||
163 | array('id' => $schedule_id), |
||
164 | array( |
||
165 | '%s', |
||
166 | '%s' |
||
167 | ) |
||
168 | ); |
||
169 | |||
170 | return $update; |
||
171 | } |
||
172 | |||
173 | public function update_hash( $schedule_id, $hash ) { |
||
189 | } |
||
190 | |||
191 | public function update_last_backup($schedule_id, $last_backup) { |
||
192 | |||
193 | $this->logger->info(sprintf('Updating last backup %s for schedule id #%s', $last_backup, $schedule_id)); |
||
194 | |||
195 | $schedule['last_backup'] = $last_backup; |
||
196 | |||
197 | $update = $this->db->update( |
||
198 | $this->scheduler_table, |
||
199 | $schedule, |
||
200 | array('id' => $schedule_id), |
||
201 | array( |
||
202 | '%s', |
||
203 | '%s' |
||
204 | ) |
||
205 | ); |
||
206 | |||
207 | return $update; |
||
208 | } |
||
209 | |||
210 | private function _xcloner_scheduler_callback( $id, $schedule ) { |
||
211 | set_time_limit( 0 ); |
||
212 | |||
213 | $xcloner = new XCloner(); |
||
214 | $xcloner->init(); |
||
215 | $this->set_xcloner_container( $xcloner ); |
||
216 | |||
217 | #$hash = $this->xcloner_settings->get_hash(); |
||
218 | #$this->get_xcloner_container()->get_xcloner_settings()->set_hash($hash); |
||
219 | |||
220 | //$this->xcloner_settings = $this->get_xcloner_container()->get_xcloner_settings(); |
||
221 | $this->xcloner_file_system = $this->get_xcloner_container()->get_xcloner_filesystem(); |
||
222 | $this->xcloner_encryption = $this->get_xcloner_container()->get_xcloner_encryption(); |
||
223 | $this->xcloner_database = $this->get_xcloner_container()->get_xcloner_database(); |
||
224 | $this->archive_system = $this->get_xcloner_container()->get_archive_system(); |
||
225 | $this->logger = $this->get_xcloner_container()->get_xcloner_logger()->withName( "xcloner_scheduler" ); |
||
226 | $this->xcloner_remote_storage = $this->get_xcloner_container()->get_xcloner_remote_storage(); |
||
227 | |||
228 | $this->logger->info( sprintf( "New schedule hash is %s", $this->xcloner_settings->get_hash() ) ); |
||
229 | |||
230 | if ( isset( $schedule['backup_params']->diff_start_date ) && $schedule['backup_params']->diff_start_date ) { |
||
231 | $this->xcloner_file_system->set_diff_timestamp_start( $schedule['backup_params']->diff_start_date ); |
||
232 | } |
||
233 | |||
234 | if ( $schedule['recurrence'] == "single" ) { |
||
235 | $this->disable_single_cron( $schedule['id'] ); |
||
236 | } |
||
237 | |||
238 | if ( ! $schedule ) { |
||
239 | $this->logger->info( sprintf( "Could not load schedule with id'%s'", $id ), array( "CRON" ) ); |
||
240 | |||
241 | return; |
||
242 | } |
||
243 | |||
244 | //echo $this->get_xcloner_container()->get_xcloner_settings()->get_hash(); exit; |
||
245 | |||
246 | $this->update_hash( $schedule['id'], $this->xcloner_settings->get_hash() ); |
||
247 | |||
248 | $this->logger->info( sprintf( "Starting cron schedule '%s'", $schedule['name'] ), array( "CRON" ) ); |
||
249 | |||
250 | $this->xcloner_file_system->set_excluded_files( json_decode( $schedule['excluded_files'] ) ); |
||
251 | |||
252 | $init = 1; |
||
253 | $continue = 1; |
||
254 | |||
255 | while ( $continue ) { |
||
256 | $continue = $this->xcloner_file_system->start_file_recursion( $init ); |
||
257 | |||
258 | $init = 0; |
||
259 | } |
||
260 | |||
261 | $this->logger->info( sprintf( "File scan finished" ), array( "CRON" ) ); |
||
262 | |||
263 | $this->logger->info( sprintf( "Starting the database backup" ), array( "CRON" ) ); |
||
264 | |||
265 | $init = 1; |
||
266 | $return['finished'] = 0; |
||
267 | |||
268 | while ( ! $return['finished'] ) { |
||
269 | $return = $this->xcloner_database->start_database_recursion( (array) json_decode( $schedule['table_params'] ), $return, $init ); |
||
270 | $init = 0; |
||
271 | } |
||
272 | |||
273 | $this->logger->info( sprintf( "Database backup done" ), array( "CRON" ) ); |
||
274 | |||
275 | $this->logger->info( sprintf( "Starting file archive process" ), array( "CRON" ) ); |
||
276 | |||
277 | $init = 0; |
||
278 | $return['finished'] = 0; |
||
279 | $return['extra'] = array(); |
||
280 | |||
281 | while ( ! $return['finished'] ) { |
||
282 | $return = $this->archive_system->start_incremental_backup( (array) $schedule['backup_params'], $return['extra'], $init ); |
||
283 | $init = 0; |
||
284 | } |
||
285 | $this->logger->info( sprintf( "File archive process FINISHED." ), array( "CRON" ) ); |
||
286 | |||
287 | //getting the last backup archive file |
||
288 | $return['extra']['backup_parent'] = $this->archive_system->get_archive_name_with_extension(); |
||
289 | if ( $this->xcloner_file_system->is_part( $this->archive_system->get_archive_name_with_extension() ) ) { |
||
290 | $return['extra']['backup_parent'] = $this->archive_system->get_archive_name_multipart(); |
||
291 | } |
||
292 | |||
293 | //Updating schedule last backup archive |
||
294 | $this->update_last_backup( $schedule['id'], $return['extra']['backup_parent'] ); |
||
295 | |||
296 | //Encrypting the backup archive |
||
297 | $return_encrypted['finished'] = 0; |
||
298 | $return_encrypted['start'] = 0; |
||
299 | $return_encrypted['iv'] = ''; |
||
300 | $return_encrypted['target_file'] = ''; |
||
301 | $part = 0; |
||
302 | $backup_parts = array(); |
||
303 | |||
304 | if( $schedule['backup_params']->backup_encrypt){ |
||
305 | $this->logger->info( sprintf( "Encrypting backup archive %s.", $return['extra']['backup_parent'] ), array( "CRON" ) ); |
||
306 | |||
307 | $backup_file = $return['extra']['backup_parent']; |
||
308 | |||
309 | if ($this->xcloner_file_system->is_multipart($return['extra']['backup_parent'])) { |
||
310 | $backup_parts = $this->xcloner_file_system->get_multipart_files($return['extra']['backup_parent']); |
||
311 | $backup_file = $backup_parts[$part]; |
||
312 | } |
||
313 | |||
314 | while ( ! $return_encrypted['finished'] ) { |
||
315 | $return_encrypted = $this->xcloner_encryption->encrypt_file( |
||
316 | $backup_file, |
||
317 | "", |
||
318 | "", |
||
319 | "", |
||
320 | "", |
||
321 | true, |
||
322 | true |
||
323 | ); |
||
324 | |||
325 | if($return_encrypted['finished']) { |
||
326 | ++$part; |
||
327 | |||
328 | if ($part < sizeof($backup_parts)) { |
||
329 | $return_encrypted['finished'] = 0; |
||
330 | $backup_file = $backup_parts[$part]; |
||
331 | } |
||
332 | } |
||
333 | } |
||
334 | } |
||
335 | |||
336 | //Sending backup to remote storage |
||
337 | if ( isset( $schedule['remote_storage'] ) && $schedule['remote_storage'] && array_key_exists( $schedule['remote_storage'], $this->xcloner_remote_storage->get_available_storages() ) ) { |
||
338 | $backup_file = $return['extra']['backup_parent']; |
||
339 | |||
340 | $this->logger->info( sprintf( "Transferring backup to remote storage %s", strtoupper( $schedule['remote_storage'] ) ), array( "CRON" ) ); |
||
341 | |||
342 | if ( method_exists( $this->xcloner_remote_storage, "upload_backup_to_storage" ) ) { |
||
343 | call_user_func_array( array( |
||
344 | $this->xcloner_remote_storage, |
||
345 | "upload_backup_to_storage" |
||
346 | ), array( $backup_file, $schedule['remote_storage'] ) ); |
||
347 | } |
||
348 | } |
||
349 | |||
350 | //Sending email notification |
||
351 | if ( isset( $schedule['backup_params']->email_notification ) and $to = $schedule['backup_params']->email_notification ) { |
||
352 | try { |
||
353 | $from = ""; |
||
354 | $additional['lines_total'] = $return['extra']['lines_total']; |
||
355 | $subject = sprintf( __( "%s - new backup generated %s" ), $schedule['name'], $return['extra']['backup_parent'] ); |
||
356 | |||
357 | $this->archive_system->send_notification( $to, $from, $subject, $return['extra']['backup_parent'], $schedule, "", $additional ); |
||
358 | |||
359 | } catch ( Exception $e ) { |
||
360 | $this->logger->error( $e->getMessage() ); |
||
361 | } |
||
362 | } |
||
363 | |||
364 | //CHECK IF WE SHOULD DELETE BACKUP AFTER REMOTE TRANSFER IS DONE |
||
365 | if ( $schedule['remote_storage'] && $this->xcloner_settings->get_xcloner_option( 'xcloner_cleanup_delete_after_remote_transfer' ) ) { |
||
366 | $this->logger->info( sprintf( "Deleting %s from local storage matching rule xcloner_cleanup_delete_after_remote_transfer", $return['extra']['backup_parent'] ) ); |
||
367 | $this->xcloner_file_system->delete_backup_by_name( $return['extra']['backup_parent'] ); |
||
368 | |||
369 | } |
||
370 | |||
371 | //Removing the tmp filesystem used for backup |
||
372 | $this->xcloner_file_system->remove_tmp_filesystem(); |
||
373 | |||
374 | //Backup Storage Cleanup |
||
375 | $this->xcloner_file_system->backup_storage_cleanup(); |
||
376 | |||
377 | //Filesystem Cleanup |
||
378 | $this->xcloner_file_system->cleanup_tmp_directories(); |
||
379 | } |
||
380 | |||
381 | public function xcloner_scheduler_callback( $id, $schedule = "" ) { |
||
403 | } |
||
404 | |||
405 | } |
||
406 | |||
407 | } |
||
408 | |||
409 | public function get_available_intervals() { |
||
410 | $schedules = wp_get_schedules(); |
||
411 | $new_schedules = array(); |
||
412 | |||
423 | } |
||
424 | |||
425 | |||
426 | } |
||
427 |