Options_Service.php
21.8 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
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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
<?php
namespace Wpo\Services;
use \Wpo\Core\Compatibility_Helpers;
use \Wpo\Core\WordPress_Helpers;
use \Wpo\Core\Wpmu_Helpers;
use \Wpo\Services\Log_Service;
use \Wpo\Services\Request_Service;
use \Wpo\Services\Saml2_Service;
// Prevent public access to this script
defined('ABSPATH') or die();
if (!class_exists('\Wpo\Services\Options_Service')) {
class Options_Service
{
/**
* Same as get_global_var but will try and interpret the value of the
* global variable as if it is a boolean.
*
* @since 4.6
*
* @param string $name Name of the global variable to get
* @return boolean True in case value found equals 1, "1", "true" or true, otherwise false.
*/
public static function get_global_boolean_var($name, $log = true)
{
$var = self::get_global_var($name, $log);
return ($var === true
|| $var === "1"
|| $var === 1
|| (is_string($var) && strtolower($var) == 'true')) ? true : false;
}
/**
* Same as get_global_var but will try and cast the value as a 1 dimensional array.
*
* @since 7.0
*
* @param string $name name of the global variable to get.
* @return array Value of the global variable as an array or empty if not found.
*/
public static function get_global_list_var($name, $log = true)
{
$var = self::get_global_var($name, $log);
if (is_array($var)) {
/**
* @since 20.0 Check for compatibility of the extra_user_fields.
*/
if ($name == 'extra_user_fields') {
$var = Compatibility_Helpers::update_user_field_key($var);
}
return $var;
}
return array();
}
/**
* Same as get_global_var but will try and cast the value as an integer.
*
* @since 7.0
*
* @param string $name name of the global variable to get.
* @return int Value of the global variable as an integer or else -1.
*/
public static function get_global_numeric_var($name, $log = true)
{
$var = self::get_global_var($name, $log);
return is_numeric($var) ? $var : 0;
}
/**
* Same as get_global_var but will try and cast the value as a string.
*
* @since 7.0
*
* @param string $name name of the global variable to get.
* @return int Value of the global variable as a string or else an empty string.
*/
public static function get_global_string_var($name, $log = true)
{
$var = self::get_global_var($name, $log);
return is_string($var) ? WordPress_Helpers::trim($var) : '';
}
/**
* Helper to check if this WordPress instance is multisite and
* a global boolean constant WPO_MU_USE_SUBSITE_OPTIONS has been
* configured
*
* @since 7.3
*
* @return boolean True if subsite options should be used
*/
public static function mu_use_subsite_options()
{
if (is_multisite() && defined('WPO_MU_USE_SUBSITE_OPTIONS') && true === constant('WPO_MU_USE_SUBSITE_OPTIONS')) {
return true;
}
return false;
}
/**
* Convert keys in an associative array from php style with underscore to camel case.
*
* @since 5.4
*
* @param $assoc_array string Associative options array with keys following PHP camel case naming convention.
*
* @return string Updated (associative) options array with keys following JSON naming convention.
*/
public static function to_camel_case($assoc_array)
{
$result = array();
if (!is_array($assoc_array))
return $result;
foreach ($assoc_array as $key => $value) {
$key = str_replace('-', '', $key);
$key = strtolower($key);
$cc_key = preg_replace_callback('/_([a-z])/', function ($match) {
return strtoupper($match[1]);
}, $key);
$result[$cc_key] = $value;
}
return $result;
}
/**
* Convert keys in an associative array from camel case to php style with underscore.
*
* @since 5.4
*
* @param $assoc_array string Associative options array with keys following JSON camel case naming convention.
*
* @return string Updated (associative) options array with keys following PHP naming convention.
*/
public static function from_camel_case($assoc_array)
{
$result = array();
foreach ($assoc_array as $key => $value) {
$php_key = preg_replace_callback('/([A-Z])/', function ($match) {
return "_" . strtolower($match[1]);
}, $key);
$result[$php_key] = $value;
}
return $result;
}
/**
* Helper to get an initial options array.
*
* @since 7.0
*
* @return array Array with snake cased options
*/
public static function get_default_options()
{
$default_login_url_path = parse_url(wp_login_url(), PHP_URL_PATH);
$pages_blacklist = array(
'/login/',
'admin-ajax.php',
'wp-cron.php',
'xmlrpc.php',
'/wp-json/wpo365/v1/',
$default_login_url_path,
);
$default_options = array(
'auth_scenario' => 'internet',
'mu_new_usr_default_role' => 'subscriber',
'new_usr_default_role' => 'subscriber',
'oidc_flow' => 'code',
'pages_blacklist' => $pages_blacklist,
'session_duration' => 0,
'version' => '2019',
);
return $default_options;
}
/**
* Helper to get the cached WPO365 options to the Wizard.
*
* @since 7.0
*
* @return array Array with camel cased options or an empty one if an error occurred.
*/
public static function get_options()
{
self::ensure_options_cache();
try {
return self::to_camel_case($GLOBALS['WPO_CONFIG']['options']);
} catch (\Exception $e) {
return array();
}
}
/**
* Helper to update the cached WPO365 options with options sent
* from the Wizard.
*
* @since 7.0
*
* @param array|string $updated_options camelcased options sent by Wizard
* @param boolean $is_assoc argument is a PHP assoc array
* @return bool True if successfully updated otherwise false
*/
public static function update_options($updated_options, $is_assoc = false, $reset = false)
{
/**
* @since 16.0
*/
if ($reset) {
$GLOBALS['WPO_CONFIG']['options'] = self::get_default_options();
}
self::ensure_options_cache();
try {
if (!$is_assoc) {
$camel_case_options = json_decode(base64_decode($updated_options), true);
$snake_case_options = self::from_camel_case($camel_case_options);
} else {
$snake_case_options = $updated_options;
}
$options = $GLOBALS['WPO_CONFIG']['options'];
if (!empty($options)) {
foreach ($snake_case_options as $key => $value) // add to existing options
$options[$key] = $value;
} else {
$options = $snake_case_options; // or replace all options
}
ksort($options);
if (self::mu_use_subsite_options() && !Wpmu_Helpers::mu_is_network_admin()) {
update_option('wpo365_options', $options);
} else {
// For non-multisite installs, it uses get_option.
update_site_option('wpo365_options', $options);
}
$GLOBALS['WPO_CONFIG']['options'] = array();
} catch (\Exception $e) {
return false;
}
return true;
}
/**
* Deletes the WPO365 configuration
*
* @since 11.18
*/
public static function delete_options()
{
if (self::mu_use_subsite_options() && !Wpmu_Helpers::mu_is_network_admin()) {
return delete_option('wpo365_options');
} else {
// For non-multisite installs, it uses delete_option.
return delete_site_option('wpo365_options');
}
}
/**
* Simple helper to add or update an option.
*
* @since 10.0
*
* @param $name string Name of the option to add
* @param $value mixed Value of the option to add
*
* @return void
*/
public static function add_update_option($name, $value)
{
self::ensure_options_cache();
$options = $GLOBALS['WPO_CONFIG']['options'];
$options[$name] = $value;
ksort($options);
if (self::mu_use_subsite_options() && !Wpmu_Helpers::mu_is_network_admin()) {
update_option('wpo365_options', $options);
} else {
// For non-multisite installs, it uses get_option.
update_site_option('wpo365_options', $options);
}
$GLOBALS['WPO_CONFIG']['options'] = array();
}
/**
* Converts a string based key and value pair to an object style key value pair
* e.g. from "c93f6d7c-1a8b-4421-b87b-bbc67ed396a3,author;" to
* { key: "c93f6d7c-1a8b-4421-b87b-bbc67ed396a3", value="author" }
*
* @since 5.4
*
* @param $option string Key value pairs as string e.g. key1,value1;key2,value2;...
*
* @return Array associative array in the form of array( 'key1' => 'value2', 'key2' => 'value2' )...
*/
private static function to_keyvalues($option)
{
if (false === is_string($option))
return array();
$kv_str_arr = array_filter(explode(';', WordPress_Helpers::trim($option)));
$kv_arr = array_map(function ($kv_str) {
$kv = array_filter(explode(',', $kv_str));
return array('key' => $kv[0], 'value' => $kv[1]);
}, $kv_str_arr);
$kv_arr = is_array($kv_arr) ? $kv_arr : array();
return $kv_arr;
}
/**
* Inspects the array provided whether tenant, application and redirect url have been
* specified.
*
* @since 7.3
*
* @return boolean True if wpo365 is configured otherwise false
*/
public static function is_wpo365_configured()
{
$request_service = Request_Service::get_instance();
$request = $request_service->get_request($GLOBALS['WPO_CONFIG']['request_id']);
$is_wpo365_configured = $request->get_item('is_wpo365_configured');
// Use the cached outcome if any
if (false !== $is_wpo365_configured) {
return ($is_wpo365_configured === 1);
}
// Assume WPO365 is configured
$is_wpo365_configured = 1;
// Save the current options - we'll restore them immediately after
$options_to_keep = $GLOBALS['WPO_CONFIG']['options'];
// Get the options
$options = (self::mu_use_subsite_options() && !Wpmu_Helpers::mu_is_network_admin())
? get_option('wpo365_options', self::get_default_options())
: get_site_option('wpo365_options', self::get_default_options());
// Replace the current options
$GLOBALS['WPO_CONFIG']['options'] = $options;
$tentant_id_ok = !empty(self::get_aad_option('tenant_id'));
if (!$tentant_id_ok) {
$is_wpo365_configured = 0;
Log_Service::write_log('WARN', __METHOD__ . ' -> WPO365 is not configured -> Tenant ID is missing.');
}
if (true === self::get_global_boolean_var('use_saml')) {
if (!Saml2_Service::saml_settings(true)) {
$is_wpo365_configured = 0;
Log_Service::write_log('WARN', __METHOD__ . ' -> WPO365 is not configured -> SAML settings are invalid.');
}
} else {
$application_id_ok = !empty(self::get_aad_option('application_id'));
if (!$application_id_ok) {
$is_wpo365_configured = 0;
Log_Service::write_log('WARN', __METHOD__ . ' -> WPO365 is not configured -> Application ID is missing.');
}
$redirect_url_ok = !empty(self::get_aad_option('redirect_url'));
if (!$redirect_url_ok) {
$is_wpo365_configured = 0;
Log_Service::write_log('WARN', __METHOD__ . ' -> WPO365 is not configured -> Redirect URL is missing.');
}
}
// Restore the options
$GLOBALS['WPO_CONFIG']['options'] = $options_to_keep;
// Cache for this request
$request->set_item('is_wpo365_configured', $is_wpo365_configured);
return $is_wpo365_configured === 1;
}
/**
* Gets an AAD related option that (since v16) may be
* saved in the site's wp-config.php instead.
*
* @since 16.0
*
* @param string $option_name The option's name.
*
* @return string
*/
public static function get_aad_option($option_name)
{
if (!self::get_global_boolean_var('use_wp_config')) {
return self::get_global_string_var($option_name);
}
$blog_id = (self::mu_use_subsite_options() && !Wpmu_Helpers::mu_is_network_admin()) ? get_current_blog_id() : get_main_site_id();
$wpo_config_constant_name = 'WPO_AAD_' . $blog_id;
if (
defined($wpo_config_constant_name) &&
isset(constant($wpo_config_constant_name)[$option_name])
) {
return constant($wpo_config_constant_name)[$option_name];
}
Log_Service::write_log('ERROR', __METHOD__ . ' -> AAD option ' . $option_name . ' is not found in WP-Config.php [Config ID: ' . $wpo_config_constant_name . '].');
return '';
}
/**
* Simple helper to ensure that the AAD options were removed.
*
* @since 21.9
*
* @param mixed $options
*
* @return void
*/
private static function remove_aad_options(&$options)
{
if (!is_array($options)) {
return;
}
$options['application_id'] = '00000000-0000-0000-0000-000000000000';
$options['application_secret'] = 'See wp-config.php';
$options['app_only_application_id'] = '00000000-0000-0000-0000-000000000000';
$options['app_only_application_secret'] = 'See wp-config.php';
$options['directory_id'] = '00000000-0000-0000-0000-000000000000';
$options['mail_application_id'] = '00000000-0000-0000-0000-000000000000';
$options['mail_application_secret'] = 'See wp-config.php';
$options['mail_redirect_url'] = 'See wp-config.php';
$options['mail_tenant_id'] = '00000000-0000-0000-0000-000000000000';
$options['redirect_on_login_secret'] = 'See wp-config.php';
$options['redirect_url'] = 'See wp-config.php';
$options['saml_x509_cert'] = 'See wp-config.php';
$options['wp_rest_aad_application_id'] = '00000000-0000-0000-0000-000000000000';
$options['wp_rest_aad_application_id_uri'] = 'See wp-config.php';
}
/**
* Simple helper to override some options with values found in wp-config.php. See
* https://docs.wpo365.com/article/172-use-wp-config-php-to-override-some-config-options.
*
* @since 21.9
*
* @param mixed $options
*
* @return void
*/
private static function apply_overrides(&$options)
{
if (!is_array($options)) {
return;
}
$blog_id = (self::mu_use_subsite_options() && !Wpmu_Helpers::mu_is_network_admin()) ? get_current_blog_id() : get_main_site_id();
$wpo_config_constant_name = sprintf('WPO_OVERRIDES_%s', $blog_id);
if (defined($wpo_config_constant_name)) {
$overrides = constant($wpo_config_constant_name);
if (!is_array($overrides)) {
return;
}
}
if (!empty($overrides)) {
foreach ($overrides as $key => $value) {
if (isset($options[$key])) {
$options[$key] = $value;
}
}
}
}
/**
* Gets a global variable by its name.
*
* @param string $name Variable name as string
*
* @return object|null The global variable or WP_Error if not found
*/
private static function get_global_var($name, $log = true)
{
self::ensure_options_cache();
// Try return the requested option
if (
isset($GLOBALS['WPO_CONFIG']['options'][$name])
&& !empty($GLOBALS['WPO_CONFIG']['options'][$name])
) {
$value = $GLOBALS['WPO_CONFIG']['options'][$name];
$value_for_log = in_array($name, self::get_secret_options()) && is_string($value)
? substr($value, 0, intval(strlen($value) / 3)) . '[...]'
: (
(is_array($value) || is_object($value)
? print_r($value, true)
: $value)
);
} else {
$value_for_log = "Global variable with name $name not configured.";
}
if (true === $log) {
Log_Service::write_log('DEBUG', __METHOD__ . " -> Option: $name -> $value_for_log");
}
return empty($value)
? null
: $value;
}
/**
* Helper function to read the options into a global variable.
*
* @since 7.3
*
* @return void
*/
private static function ensure_options_cache()
{
if (empty($GLOBALS['WPO_CONFIG']['options'])) {
if (self::mu_use_subsite_options() && !Wpmu_Helpers::mu_is_network_admin()) {
$options = get_option('wpo365_options', array());
} else {
// For non-multisite installs, it uses get_option.
$options = get_site_option('wpo365_options', array());
}
if (empty($options)) {
$options = self::get_default_options();
}
/**
* @since 21.9 Remove AAD options server-side
*/
if (isset($options['use_wp_config']) && true === filter_var($options['use_wp_config'], FILTER_VALIDATE_BOOLEAN)) {
self::remove_aad_options($options);
}
/**
* @since 21.9 Override (some) config-options using WP-Config.php
*/
if (isset($options['use_wp_config_frags']) && true === filter_var($options['use_wp_config_frags'], FILTER_VALIDATE_BOOLEAN)) {
self::apply_overrides($options);
}
$GLOBALS['WPO_CONFIG']['options'] = $options;
}
}
/**
* Array with options that should be partially obscured when logged
*
* @since 7.11
*
* @return array with option names that should be obscured when logged
*/
private static function get_secret_options()
{
return array(
'app_only_application_id',
'app_only_application_secret',
'application_id',
'application_secret',
'mail_application_id',
'mail_application_secret',
'nonce_secret',
'saml_x509_cert',
'tenant_id',
);
}
}
}