upgrades.php
4.72 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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
<?php
/**
* Backward compatibility functions.
*
* @package ContentControl
*/
namespace ContentControl;
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
use function wp_parse_args;
use function apply_filters;
/**
* Get the current data versions.
*
* @return int[]
*/
function current_data_versions() {
return apply_filters( 'content_control/current_data_versions', [
'backup' => 2,
'settings' => 2,
'restrictions' => 2,
'plugin_meta' => 2,
'user_meta' => 2,
] );
}
/**
* Get all data versions.
*
* @return int[]
*/
function get_data_versions() {
$versioning = \get_option( 'content_control_data_versioning', [] );
return wp_parse_args( $versioning, current_data_versions() );
}
/**
* Set the data version.
*
* @param string $key Data key.
* @param int $version Data version.
*
* @return bool
*/
function set_data_version( $key, $version ) {
$versioning = get_data_versions();
$versioning[ $key ] = $version;
return set_data_versions( $versioning );
}
/**
* Set the data version.
*
* @param int[] $versioning Data versions.
*
* @return bool
*/
function set_data_versions( $versioning ) {
$versioning = wp_parse_args( $versioning, get_data_versions() );
return \update_option( 'content_control_data_versioning', $versioning );
}
/**
* Get the current data version.
*
* @param string $key Type of data to get version for.
*
* @return int|bool
*/
function get_data_version( $key ) {
$versioning = get_data_versions();
switch ( $key ) {
// Fallthrough.
case 'restrictions':
// If set to v1 and there are no v1 restrictions, set to v2.
if ( 1 === $versioning[ $key ] ) {
$v1_restrictions = get_v1_restrictions();
if ( false === $v1_restrictions ) {
$versioning[ $key ] = 2;
set_data_versions( $versioning );
return 2;
}
}
break;
case 'settings':
// If set to v1 and there are no v1 settings, set to v2.
if ( 1 === $versioning[ $key ] ) {
$v1_settings = \get_option( 'jp_cc_settings', [] );
if ( empty( $v1_settings ) ) {
$versioning[ $key ] = 2;
$versioning['backup'] = 2; // Backup is always the same as settings.
set_data_versions( $versioning );
return 2;
}
}
break;
}
return isset( $versioning[ $key ] ) ? $versioning[ $key ] : false;
}
/**
* Checks if user is upgrading from < 2.0.0.
*
* Sets data versioning to 1 as they didn't exist before.
*
* @param string $old_version Old version.
*
* @return void
*/
function maybe_force_v2_migrations( $old_version ) {
if ( version_compare( $old_version, '2.0.0', '<' ) ) {
$versioning = get_data_versions();
// Forces updates for all data types to v2.
$versioning = wp_parse_args( [
'backup' => 1,
'settings' => 1,
'restrictions' => 1,
'plugin_meta' => 1,
'user_meta' => 1,
], $versioning );
\update_option( 'content_control_data_versioning', $versioning );
}
}
/**
* Get the name of an upgrade.
*
* @param string|\ContentControl\Base\Upgrade $upgrade Upgrade to get name for.
*
* @return string
*/
function get_upgrade_name( $upgrade ) {
if ( is_object( $upgrade ) ) {
$upgrade = $upgrade::TYPE . '-' . $upgrade::VERSION;
}
return $upgrade;
}
/**
* Get the completed upgrades.
*
* @return string[]
*/
function get_completed_upgrades() {
return \get_option( 'content_control_completed_upgrades', [] );
}
/**
* Set the completed upgrades.
*
* @param string[] $upgrades Completed upgrades.
*
* @return bool
*/
function set_completed_upgrades( $upgrades ) {
return \update_option( 'content_control_completed_upgrades', $upgrades );
}
/**
* Mark an upgrade as complete.
*
* @param \ContentControl\Base\Upgrade $upgrade Upgrade to mark as complete.
*
* @return void
*/
function mark_upgrade_complete( $upgrade ) {
$upgrade_name = get_upgrade_name( $upgrade );
$upgrades = get_completed_upgrades();
if ( ! in_array( $upgrade_name, $upgrades, true ) ) {
$upgrades[] = $upgrade_name;
}
set_completed_upgrades( $upgrades );
// Update the data version.
set_data_version( $upgrade::TYPE, $upgrade::VERSION );
/**
* Fires when an upgrade is marked as complete.
*
* @param \ContentControl\Base\Upgrade $upgrade Upgrade type.
*/
do_action( 'content_control/upgrade_complete', $upgrade );
/**
* Fires when a specific upgrade is marked as complete.
*
* @param \ContentControl\Base\Upgrade $upgrade Upgrade type.
*/
do_action( "content_control/upgrade_complete/{$upgrade_name}", $upgrade );
}
/**
* Check if an upgrade has been completed.
*
* @param string|\ContentControl\Base\Upgrade $upgrade Upgrade to check.
*
* @return bool
*/
function is_upgrade_complete( $upgrade ) {
$upgrade = get_upgrade_name( $upgrade );
$upgrades = get_completed_upgrades();
return in_array( $upgrade, $upgrades, true );
}