1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace HM\BackUpWordPress; |
4
|
|
|
|
5
|
|
|
/** |
6
|
|
|
* Manages status and progress of a backup |
7
|
|
|
*/ |
8
|
|
|
class Backup_Status { |
9
|
|
|
|
10
|
|
|
private $filename = ''; |
11
|
|
|
|
12
|
|
|
public function __construct( $id ) { |
13
|
|
|
$this->id = $id; |
|
|
|
|
14
|
|
|
} |
15
|
|
|
|
16
|
|
|
public function start( $backup_filename, $status_message ) { |
17
|
|
|
$this->filename = $backup_filename; |
18
|
|
|
$this->set_status( $status_message ); |
19
|
|
|
} |
20
|
|
|
|
21
|
|
|
public function get_backup_filename() { |
|
|
|
|
22
|
|
|
|
23
|
|
|
if ( $this->is_started() ) { |
24
|
|
|
$status = json_decode( file_get_contents( $this->get_status_filepath() ) ); |
25
|
|
|
|
26
|
|
|
if ( ! empty( $status->filename ) ) { |
27
|
|
|
$this->filename = $status->filename; |
28
|
|
|
} |
29
|
|
|
} |
30
|
|
|
|
31
|
|
|
return $this->filename; |
32
|
|
|
} |
33
|
|
|
|
34
|
|
|
public function is_started() { |
35
|
|
|
return (bool) file_exists( $this->get_status_filepath() ); |
36
|
|
|
} |
37
|
|
|
|
38
|
|
|
public function finish() { |
39
|
|
|
// Delete the backup running file |
40
|
|
|
if ( file_exists( $this->get_status_filepath() ) ) { |
41
|
|
|
unlink( $this->get_status_filepath() ); |
42
|
|
|
} |
43
|
|
|
} |
44
|
|
|
|
45
|
|
|
/** |
46
|
|
|
* Get the status of the running backup. |
47
|
|
|
* |
48
|
|
|
* @return string |
49
|
|
|
*/ |
50
|
|
|
public function get_status() { |
51
|
|
|
|
52
|
|
|
if ( ! file_exists( $this->get_status_filepath() ) ) { |
53
|
|
|
return ''; |
54
|
|
|
} |
55
|
|
|
|
56
|
|
|
$status = json_decode( file_get_contents( $this->get_status_filepath() ) ); |
57
|
|
|
|
58
|
|
|
if ( ! empty( $status->status ) ) { |
59
|
|
|
return $status->status; |
60
|
|
|
} |
61
|
|
|
|
62
|
|
|
return ''; |
63
|
|
|
|
64
|
|
|
} |
65
|
|
|
|
66
|
|
|
/** |
67
|
|
|
* Set the status of the running backup |
68
|
|
|
* |
69
|
|
|
* @param string $message |
70
|
|
|
* |
71
|
|
|
* @return null |
|
|
|
|
72
|
|
|
*/ |
73
|
|
|
public function set_status( $message ) { |
74
|
|
|
|
75
|
|
|
// If start hasn't been called yet then we wont' have a backup filename |
76
|
|
|
if ( ! $this->filename ) { |
77
|
|
|
return ''; |
78
|
|
|
} |
79
|
|
|
|
80
|
|
|
$status = json_encode( (object) array( |
81
|
|
|
'filename' => $this->filename, |
82
|
|
|
'started' => $this->get_start_time(), |
83
|
|
|
'status' => $message, |
84
|
|
|
) ); |
85
|
|
|
|
86
|
|
|
file_put_contents( $this->get_status_filepath(), $status ); |
87
|
|
|
|
88
|
|
|
} |
89
|
|
|
|
90
|
|
|
/** |
91
|
|
|
* Get the time that the current running backup was started |
92
|
|
|
* |
93
|
|
|
* @return int $timestamp |
94
|
|
|
*/ |
95
|
|
|
public function get_start_time() { |
96
|
|
|
|
97
|
|
|
if ( ! file_exists( $this->get_status_filepath() ) ) { |
98
|
|
|
return 0; |
99
|
|
|
} |
100
|
|
|
|
101
|
|
|
$status = json_decode( file_get_contents( $this->get_status_filepath() ) ); |
102
|
|
|
|
103
|
|
|
if ( ! empty( $status->started ) && (int) (string) $status->started === $status->started ) { |
104
|
|
|
return $status->started; |
105
|
|
|
} |
106
|
|
|
|
107
|
|
|
return time(); |
108
|
|
|
|
109
|
|
|
} |
110
|
|
|
|
111
|
|
|
/** |
112
|
|
|
* Get the path to the backup running file that stores the running backup status |
113
|
|
|
* |
114
|
|
|
* @return string |
115
|
|
|
*/ |
116
|
|
|
public function get_status_filepath() { |
117
|
|
|
return Path::get_path() . '/.backup-' . $this->id . '-running'; |
118
|
|
|
} |
119
|
|
|
} |
120
|
|
|
|
In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:
Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: