/
onesignal-settings.php
280 lines (263 loc) · 12.8 KB
/
onesignal-settings.php
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
<?php
defined( 'ABSPATH' ) or die('This page may not be accessed directly.');
class OneSignal {
public static function get_onesignal_settings() {
/*
During first-time setup, all the keys here will be created with their
default values, except for keys with value 'CALCULATE_LEGACY_VALUE' or
'CALCULATE_SPECIAL_VALUE'. These special keys aren't created until further
below.
*/
$defaults = array(
'app_id' => '',
'gcm_sender_id' => '',
'prompt_auto_register' => 'CALCULATE_LEGACY_VALUE',
'send_welcome_notification' => 'CALCULATE_LEGACY_VALUE',
'welcome_notification_title' => '',
'welcome_notification_message' => '',
'welcome_notification_url' => '',
'notification_on_post' => true,
'notification_on_post_from_plugin' => false,
'is_site_https_firsttime' => 'unset',
'is_site_https' => false,
'use_modal_prompt' => false,
'subdomain' => "",
'origin' => "",
'default_title' => "",
'default_icon' => "",
'default_url' => "",
'app_rest_api_key' => "",
'safari_web_id' => "",
'showNotificationIconFromPostThumbnail' => true,
'showNotificationImageFromPostThumbnail' => 'CALCULATE_SPECIAL_VALUE',
'chrome_auto_dismiss_notifications' => false,
'prompt_customize_enable' => 'CALCULATE_SPECIAL_VALUE',
'prompt_action_message' => "",
'prompt_example_notification_title_desktop' => "",
'prompt_example_notification_message_desktop' => "",
'prompt_example_notification_title_mobile' => "",
'prompt_example_notification_message_mobile' => "",
'prompt_example_notification_caption' => "",
'prompt_accept_button_text' => "",
'prompt_cancel_button_text' => "",
'prompt_auto_accept_title' => "",
'prompt_site_name' => "",
'notifyButton_position' => 'bottom-right',
'notifyButton_size' => 'medium',
'notifyButton_theme' => 'default',
'notifyButton_enable' => 'CALCULATE_SPECIAL_VALUE',
'notifyButton_customize_enable' => 'CALCULATE_SPECIAL_VALUE',
'notifyButton_customize_colors_enable' => false,
'notifyButton_customize_offset_enable' => false,
'notifyButton_color_background' => '',
'notifyButton_color_foreground' => '',
'notifyButton_color_badge_background' => '',
'notifyButton_color_badge_foreground' => '',
'notifyButton_color_badge_border' => '',
'notifyButton_color_pulse' => '',
'notifyButton_color_popup_button_background' => '',
'notifyButton_color_popup_button_background_hover' => '',
'notifyButton_color_popup_button_background_active' => '',
'notifyButton_color_popup_button_color' => '',
'notifyButton_offset_bottom' => '',
'notifyButton_offset_left' => '',
'notifyButton_offset_right' => '',
'notifyButton_showcredit' => true,
'notifyButton_showAfterSubscribed' => true,
'notifyButton_tip_state_unsubscribed' => '',
'notifyButton_tip_state_subscribed' => '',
'notifyButton_tip_state_blocked' => '',
'notifyButton_message_action_subscribed' => '',
'notifyButton_message_action_resubscribed' => '',
'notifyButton_message_action_unsubscribed' => '',
'notifyButton_dialog_main_title' => '',
'notifyButton_dialog_main_button_subscribe' => '',
'notifyButton_dialog_main_button_unsubscribe' => '',
'notifyButton_dialog_blocked_title' => '',
'notifyButton_dialog_blocked_message' => '',
'utm_additional_url_params' => '',
'allowed_custom_post_types' => '',
'notification_title' => OneSignalUtils::decode_entities(get_bloginfo('name')),
'send_to_mobile_platforms' => false,
'show_gcm_sender_id' => false,
'use_custom_manifest' => false,
'custom_manifest_url' => '',
'use_custom_sdk_init' => false,
'show_notification_send_status_message' => true,
'use_http_permission_request' => 'CALCULATE_SPECIAL_VALUE',
'persist_notifications' => 'CALCULATE_SPECIAL_VALUE',
/*
* 'onesignal_sw_js' => true -> this is false people who
* upgraded from version 2.1.7
*/
);
$legacies = array(
'send_welcome_notification.legacyKey' => 'no_welcome_notification',
'send_welcome_notification.invertLegacyValue' => true,
'send_welcome_notification.default' => true,
'prompt_auto_register.legacyKey' => 'no_auto_register',
'prompt_auto_register.invertLegacyValue' => true,
'prompt_auto_register.default' => false,
);
$is_new_user = false;
// If not set or empty, load a fresh empty array
$onesignal_wp_settings = get_option("OneSignalWPSetting");
if (empty( $onesignal_wp_settings )) {
$is_new_user = true;
$onesignal_wp_settings = array();
}
// Assign defaults if the key doesn't exist in $onesignal_wp_settings
// Except for those with value CALCULATE_LEGACY_VALUE -- we need special logic for legacy values that used to exist in previous plugin versions
reset($defaults);
/*
* 'onesignal_sw_js' => true -> for new users
*/
if ($is_new_user) {
$defaults['onesignal_sw_js'] = true;
}
foreach ($defaults as $key => $value) {
if ($value === "CALCULATE_LEGACY_VALUE") {
if (!array_key_exists($key, $onesignal_wp_settings)) {
$legacyKey = $legacies[$key . '.legacyKey'];
$inverted = (array_key_exists($key . '.invertLegacyValue', $legacies) && $legacies[$key . '.invertLegacyValue']);
$default = $legacies[$key . '.default'];
if (array_key_exists($legacyKey, $onesignal_wp_settings)) {
if ($inverted) {
$onesignal_wp_settings[$key] = !$onesignal_wp_settings[$legacyKey];
} else {
$onesignal_wp_settings[$key] = $onesignal_wp_settings[$legacyKey];
}
} else {
$onesignal_wp_settings[$key] = $default;
}
}
}
else if ($value === "CALCULATE_SPECIAL_VALUE") {
// Do nothing, handle below
}
else {
if (!array_key_exists($key, $onesignal_wp_settings)) {
$onesignal_wp_settings[$key] = $value;
}
}
}
/*
For first-time setup users, the array key will not exist since keys aren't
created until inside these blocks. The array_key_exists() will return
false for first-time users.
*/
// Special case for web push images
if (!array_key_exists('showNotificationImageFromPostThumbnail', $onesignal_wp_settings)) {
if ( $is_new_user ) {
// Enable the notify button by default for new sites
$onesignal_wp_settings['showNotificationImageFromPostThumbnail'] = true;
} else {
// Do NOT enable the notify button for existing WordPress sites, since they may not like the way their notification changes
$onesignal_wp_settings['showNotificationImageFromPostThumbnail'] = false;
}
}
// Special case for notify button
if (!array_key_exists('notifyButton_enable', $onesignal_wp_settings)) {
if ( $is_new_user ) {
// Enable the notify button by default for new sites
$onesignal_wp_settings['notifyButton_enable'] = true;
} else {
// Do NOT enable the notify button for existing WordPress sites, since they might have a lot of users
$onesignal_wp_settings['notifyButton_enable'] = false;
}
}
// Special case for notify button customization
if (!array_key_exists('notifyButton_customize_enable', $onesignal_wp_settings)) {
if ( $is_new_user ) {
// Initially turn off notifyButton_customize_enable by default for new sites
$onesignal_wp_settings['notifyButton_customize_enable'] = true;
} else {
$text_customize_settings = array(
'notifyButton_tip_state_unsubscribed',
'notifyButton_tip_state_subscribed',
'notifyButton_tip_state_blocked',
'notifyButton_message_action_subscribed',
'notifyButton_message_action_resubscribed',
'notifyButton_message_action_unsubscribed',
'notifyButton_dialog_main_title',
'notifyButton_dialog_main_button_subscribe',
'notifyButton_dialog_main_button_unsubscribe',
'notifyButton_dialog_blocked_title',
'notifyButton_dialog_blocked_message'
);
$was_customized = false;
foreach ($text_customize_settings as $text_customize_setting) {
if ($onesignal_wp_settings[$text_customize_setting] !== "") {
$was_customized = true;
}
}
$onesignal_wp_settings['notifyButton_customize_enable'] = $was_customized;
}
}
// Special case for prompt customization
if (!array_key_exists('prompt_customize_enable', $onesignal_wp_settings)) {
if ( $is_new_user ) {
// Initially turn off prompt_customize_enable by default for new sites
$onesignal_wp_settings['prompt_customize_enable'] = true;
} else {
$text_customize_settings = array(
'prompt_action_message',
'prompt_example_notification_title_desktop',
'prompt_example_notification_message_desktop',
'prompt_example_notification_title_mobile',
'prompt_example_notification_message_mobile',
'prompt_example_notification_caption',
'prompt_accept_button_text',
'prompt_cancel_button_text'
);
$was_customized = false;
foreach ($text_customize_settings as $text_customize_setting) {
if ($onesignal_wp_settings[$text_customize_setting] !== "") {
$was_customized = true;
}
}
$onesignal_wp_settings['prompt_customize_enable'] = $was_customized;
}
}
// Special case for HTTP permission request
if (!array_key_exists('use_http_permission_request', $onesignal_wp_settings)) {
if ($is_new_user) {
// Enable by default for new sites
$onesignal_wp_settings['use_http_permission_request'] = true;
} else {
// Do NOT enable for existing WordPress sites, since it breaks existing prompt behavior
$onesignal_wp_settings['use_http_permission_request'] = false;
}
}
// Special case for persistent notifications
if (!array_key_exists('persist_notifications', $onesignal_wp_settings)) {
if ( $is_new_user ) {
// Initially set persist_notifications to yes by default for new sites,
// except on platforms like Mac where a notification manager is used
$onesignal_wp_settings['persist_notifications'] = 'yes-except-notification-manager-platforms';
} else {
// This was the old key name for persist_notifications
if (array_key_exists('chrome_auto_dismiss_notifications', $onesignal_wp_settings)) {
if ($onesignal_wp_settings['chrome_auto_dismiss_notifications'] === "1") {
// The user wants notifications to be dismissed
$onesignal_wp_settings['persist_notifications'] = 'platform-default';
} else {
// The user did not enable this option, and wanted notifications to be persisted (default at that time)
$onesignal_wp_settings['persist_notifications'] = 'yes-except-notification-manager-platforms';
}
} else {
$onesignal_wp_settings['persist_notifications'] = 'yes-except-notification-manager-platforms';
}
}
}
$onesignal_settings_values_without_slashes = stripslashes_deep($onesignal_wp_settings);
return apply_filters( 'onesignal_get_settings', $onesignal_settings_values_without_slashes );
}
public static function save_onesignal_settings($settings) {
$onesignal_wp_settings = $settings;
update_option("OneSignalWPSetting", $onesignal_wp_settings);
}
public static function maskedRestApiKey($rest_api_key) {
return str_repeat('*', 44) . substr($rest_api_key, -4);
}
}