UpgradeStream.php
4.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
<?php
/**
* Plugin controller.
*
* @copyright (c) 2021, Code Atlantic LLC.
*
* @package ContentControl
*/
namespace ContentControl\Services;
use function ContentControl\plugin;
defined( 'ABSPATH' ) || exit;
/**
* HTTP Stream class.
*/
class UpgradeStream extends \ContentControl\Base\Stream {
/**
* Upgrade status.
*
* @var array{total:int,progress:int,currentTask:null|array{name:string,total:int,progress:int}}|null
*/
public $status = [
'total' => 0,
'progress' => 0,
'currentTask' => null,
];
/**
* Update the status of the upgrade.
*
* @param array{total?:int|null,progress?:int|null,curentTask?:string|null} $status Status to update.
*
* @return void
*/
public function update_status( $status ) {
$defaults = [
'total' => 0,
'progress' => 0,
'currentTask' => null,
];
// Merge with existing status.
$status = wp_parse_args(
$status,
$this->status ? (array) $this->status : []
);
// Update status (merge with defaults).
$this->status = array_merge( $defaults, $status );
}
/**
* Update the status of the current task.
*
* @param array{total?:int,progress?:int,curentTask?:string}|null $task_status Status to update.
*
* @return void
*/
public function update_task_status( $task_status ) {
$defaults = [
'name' => '',
'total' => 0,
'progress' => 0,
];
if ( null === $task_status ) {
// Reset current task.
$this->status['currentTask'] = null;
} else {
// Merge with existing status.
$task_status = wp_parse_args(
$task_status,
$this->status['currentTask'] ? (array) $this->status['currentTask'] : []
);
// Update status (merge with defaults).
$this->status['currentTask'] = array_merge( $defaults, $task_status );
}
}
/**
* Send an event to the client.
*
* @param string $event Event name.
* @param mixed $data Data to send.
*
* @return void
*/
public function send_event( $event, $data = [] ) {
// Always send the status.
$data['status'] = $this->status;
if ( ! empty( $data['message'] ) ) {
plugin( 'logging' )->log( $data['message'] );
}
$data = \wp_json_encode( $data );
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo "event: {$event}" . PHP_EOL;
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo "data: {$data}" . PHP_EOL;
echo PHP_EOL;
$this->flush_buffers();
}
/**
* Start the upgrade process.
*
* @param int $total Number of upgrades.
* @param string $message Message to send.
*
* @return void
*/
public function start_upgrades( $total, $message = null ) {
$this->update_status( [
'total' => $total,
'progress' => 0,
'currentTask' => null,
] );
$this->send_event( 'upgrades:start', [
'message' => $message ? $message : __( 'Starting upgrades...', 'content-control' ),
] );
}
/**
* Complete the upgrade process.
*
* @param string $message Message to send.
*
* @return void
*/
public function complete_upgrades( $message = null ) {
$this->update_status( [
'progress' => $this->status['total'],
'currentTask' => null,
] );
$this->send_event( 'upgrades:complete', [
'message' => $message ? $message : __( 'Upgrades complete.', 'content-control' ),
] );
}
/**
* Start a task.
*
* @param string $name Task name.
* @param int $task_steps Number of steps in the task.
* @param string $message Message to send.
*
* @return void
*/
public function start_task( $name, $task_steps = 1, $message = null ) {
$this->update_task_status( [
'name' => $name,
'progress' => 0,
'total' => $task_steps,
] );
$this->send_event( 'task:start', [
'message' => $message ? $message : $name,
] );
}
/**
* Update the progress of the current task.
*
* @param int $progress Progress of the task.
*
* @return void
*/
public function update_task_progress( $progress ) {
$this->update_task_status( [
'progress' => $progress,
] );
$this->send_event( 'task:progress', [] );
}
/**
* Complete the current task.
*
* @param string $message Message to send.
*
* @return void
*/
public function complete_task( $message = null ) {
$task_status = $this->status['currentTask'];
$this->update_task_status( null );
$this->update_status( [
'progress' => $this->status['progress'] + 1,
] );
$this->send_event( 'task:complete', [
// translators: %s: task name.
'message' => $message ? $message : sprintf( __( 'Completed: %s', 'content-control' ), $task_status['name'] ),
] );
}
}