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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
|
<?php
/**
* Handles the Opt-in status for the site.
*
* @since 1.0.0
*
* @package StellarWP\Telemetry
*/
namespace StellarWP\Telemetry\Opt_In;
use StellarWP\Telemetry\Config;
use StellarWP\Telemetry\Core;
/**
* Class for handling the Opt-in status for the site.
*
* @since 1.0.0
*
* @package StellarWP\Telemetry
*/
class Status {
public const OPTION_NAME = 'stellarwp_telemetry';
public const OPTION_NAME_USER_INFO = 'stellarwp_telemetry_user_info';
public const STATUS_ACTIVE = 1;
public const STATUS_INACTIVE = 2;
/**
* Gets the option name used to store the opt-in status.
*
* @since 1.0.0
*
* @return string
*/
public function get_option_name() {
/**
* Filters the option name used to store the opt-in status.
*
* @since 1.0.0
*
* @param string $option_name
*/
return apply_filters( 'stellarwp/telemetry/' . Config::get_hook_prefix() . 'option_name', self::OPTION_NAME );
}
/**
* Gets the current opt-in status.
*
* @since 1.0.0
*
* @return array
*/
public function get_option() {
$option = get_option( $this->get_option_name(), [] );
return is_array( $option ) ? $option : [];
}
/**
* Gets the current Opt-in status.
*
* The status is stored as an integer because there are multiple possible statuses:
* 1 = Active
* 2 = Inactive
*
* @since 1.0.0
* @since 2.0.1 Correct logic so it is not subject to the order of the plugins.
* @since 2.2.0 Update to remove unnecessary "mixed" status.
*
* @return integer The status value.
*/
public function get() {
$status = self::STATUS_INACTIVE;
$option = $this->get_option();
$plugins = $option['plugins'] ?? [];
if ( count( $plugins ) === 0 ) {
$status = self::STATUS_INACTIVE;
}
foreach ( $plugins as $plugin ) {
// If any plugins are missing an optin status or at least one is false, set status to false.
if ( ! isset( $plugin['optin'] ) || false === $plugin['optin'] ) {
$status = self::STATUS_INACTIVE;
break;
}
$status = self::STATUS_ACTIVE;
}
/**
* Filters the opt-in status value.
*
* @since 1.0.0
*
* @param integer $status The opt-in status value.
*/
return apply_filters( 'stellarwp/telemetry/' . Config::get_hook_prefix() . 'optin_status', $status );
}
/**
* Gets the site auth token.
*
* @since 1.0.0
*
* @return string
*/
public function get_token() {
$option = $this->get_option();
/**
* Filters the site auth token.
*
* @since 1.0.0
*
* @param string $token The site's auth token.
*/
return apply_filters( 'stellarwp/telemetry/' . Config::get_hook_prefix() . 'token', $option['token'] ?? '' );
}
/**
* Determines if the plugin slug exists in the opt-in option array.
*
* @since 1.0.0
*
* @param string $stellar_slug The plugin's unique slug.
*
* @return boolean
*/
public function plugin_exists( string $stellar_slug ) {
$option = $this->get_option();
$plugins = $option['plugins'] ?? [];
return array_key_exists( $stellar_slug, $plugins );
}
/**
* Adds a plugin slug to the opt-in option array.
*
* @since 1.0.0
*
* @param string $stellar_slug The unique slug identifier for the plugin.
* @param boolean $status The opt-in status for the plugin.
* @param string $plugin_basename The specific basename for the plugin.
*
* @return boolean
*/
public function add_plugin( string $stellar_slug, bool $status = false, string $plugin_basename = '' ) {
$option = $this->get_option();
if ( '' === $plugin_basename ) {
$plugin_basename = Config::get_container()->get( Core::PLUGIN_BASENAME );
}
$option['plugins'][ $stellar_slug ] = [
'wp_slug' => $plugin_basename,
'optin' => $status,
];
return update_option( $this->get_option_name(), $option );
}
/**
* Removes a plugin slug from the opt-in option array.
*
* @since 1.0.0
*
* @param string $stellar_slug The slug to remove from the option.
*
* @return boolean
*/
public function remove_plugin( string $stellar_slug ) {
$option = $this->get_option();
// Bail early if the slug does not exist in the option.
if ( ! isset( $option['plugins'][ $stellar_slug ] ) ) {
return false;
}
unset( $option['plugins'][ $stellar_slug ] );
return update_option( $this->get_option_name(), $option );
}
/**
* Get an array of opted-in plugins.
*
* @since 1.0.0
*
* @return array<int, array<string, string>>
*/
public function get_opted_in_plugins() {
$option = $this->get_option();
$site_plugins_dir = Config::get_container()->get( Core::SITE_PLUGIN_DIR );
$opted_in_plugins = [];
// If the status option is not an option, return early.
if ( ! isset( $option['plugins'] ) ) {
return $opted_in_plugins;
}
foreach ( $option['plugins'] as $stellar_slug => $plugin ) {
if ( ! isset( $plugin['wp_slug'] ) ) {
continue;
}
$plugin_data = get_plugin_data( trailingslashit( $site_plugins_dir ) . $plugin['wp_slug'] );
if ( isset( $plugin['optin'] ) && true === $plugin['optin'] ) {
$opted_in_plugins[] = [
'slug' => $stellar_slug,
'version' => $plugin_data['Version'],
];
}
}
return $opted_in_plugins;
}
/**
* Sets the opt-in status option for the site.
*
* @since 1.0.0
* @since 2.0.0 - Updated to allow defined stellar_slug.
*
* @param boolean $status The status to set.
* @param string $stellar_slug The stellar_slug to set the status of.
*
* @return boolean
*/
public function set_status( bool $status, string $stellar_slug = '' ) {
// If no stellar slug is passed, use the singular value.
if ( '' === $stellar_slug ) {
$stellar_slug = Config::get_stellar_slug();
}
$option = $this->get_option();
$option['plugins'][ $stellar_slug ]['optin'] = $status;
return update_option( $this->get_option_name(), $option );
}
/**
* Gets the site's opt-in status label.
*
* @since 1.0.0
*
* @return string
*/
public function get_status() {
$optin_label = '';
switch ( $this->get() ) {
case 1:
$optin_label = esc_html__( 'Active', 'stellarwp-telemetry' );
break;
case 2:
$optin_label = esc_html__( 'Inactive', 'stellarwp-telemetry' );
break;
}
/**
* Filters the opt-in status label.
*
* @since 1.0.0
*
* @param string $optin-Label
*/
return apply_filters( 'stellarwp/telemetry/' . Config::get_hook_prefix() . 'optin_status_label', $optin_label );
}
/**
* Determines if the opt-in status is active.
*
* @since 1.0.0
*
* @return boolean
*/
public function is_active(): bool {
return $this->get() === self::STATUS_ACTIVE;
}
}
|