Settings.php — Independent Analytics – WordPress Analytics Plugin 2.6.0

independent-analytics / IAWP / Settings.php

independent-analytics / IAWP Last commit date

AJAX 2 years ago Admin_Page 2 years ago Custom_WordPress_Columns 2 years ago Date_Range 2 years ago Email_Reports 2 years ago Filter_Lists 2 years ago Form_Submissions 2 years ago Interval 2 years ago Menu_Bar_Stats 2 years ago Migrations 2 years ago Models 2 years ago Public_API 2 years ago Rows 2 years ago Statistics 2 years ago Tables 2 years ago Utils 2 years ago Campaign_Builder.php 2 years ago Capability_Manager.php 2 years ago Chart.php 2 years ago Chart_Geo.php 2 years ago Cron_Manager.php 2 years ago Current_Traffic_Finder.php 2 years ago Dashboard_Options.php 2 years ago Dashboard_Widget.php 2 years ago Database.php 2 years ago Database_Manager.php 2 years ago Empty_Report_Option.php 2 years ago Env.php 2 years ago Filters.php 2 years ago Geo_Database_Background_Job.php 2 years ago Geo_Database_Manager.php 2 years ago Geoposition.php 2 years ago Icon_Directory.php 2 years ago Icon_Directory_Factory.php 2 years ago Illuminate_Builder.php 2 years ago Independent_Analytics.php 2 years ago Interrupt.php 2 years ago Known_Referrers.php 2 years ago Plugin_Conflict_Detector.php 2 years ago Plugin_Group.php 2 years ago Plugin_Group_Option.php 2 years ago Query.php 2 years ago Quick_Stats.php 2 years ago REST_API.php 2 years ago Real_Time.php 2 years ago Report.php 2 years ago Report_Finder.php 2 years ago Report_Options_Parser.php 2 years ago Resource_Identifier.php 2 years ago Settings.php 2 years ago Sort_Configuration.php 2 years ago Track_Resource_Changes.php 2 years ago View.php 2 years ago View_Counter.php 2 years ago Visitors_Over_Time_Finder.php 2 years ago WP_Option_Cache_Bust.php 2 years ago WooCommerce_Order.php 2 years ago WooCommerce_Referrer_Meta_Box.php 2 years ago

Settings.php

335 lines

1	<?php
2
3	namespace IAWP;
4
5	use IAWP\Utils\Request;
6	use IAWP\Utils\String_Util;
7	/** @internal */
8	class Settings
9	{
10	public function __construct()
11	{
12	\add_action('admin_init', [$this, 'register_settings']);
13	\add_action('admin_init', [$this, 'register_view_counter_settings']);
14	\add_action('admin_init', [$this, 'register_blocked_ip_settings']);
15	\add_action('admin_init', [$this, 'register_block_by_role_settings']);
16	if (\IAWPSCOPED\iawp_is_pro()) {
17	\add_action('admin_init', [$this, 'register_email_report_settings']);
18	}
19	}
20	public function render_settings()
21	{
22	echo \IAWPSCOPED\iawp_blade()->run('settings.index');
23	if (\IAWPSCOPED\iawp_is_pro()) {
24	$defaults = $this->email_report_colors();
25	$saved = \IAWPSCOPED\iawp()->get_option('iawp_email_report_colors', $defaults);
26	// There were 6 colors and now 9, so there is a saved value but 7-9 don't exist
27	$input_defaults = $defaults;
28	for ($i = 0; $i < \count($saved); $i++) {
29	$input_defaults[$i] = $saved[$i];
30	}
31	echo \IAWPSCOPED\iawp_blade()->run('settings.email-reports', ['is_scheduled' => \wp_next_scheduled('iawp_send_email_report'), 'scheduled_date' => \IAWPSCOPED\iawp()->email_reports->next_email_at_for_humans(), 'date_comparison' => \IAWPSCOPED\iawp()->email_reports->next_event_scheduled_at(), 'interval' => \IAWPSCOPED\iawp()->get_option('iawp_email_report_interval', 'monthly'), 'time' => \IAWPSCOPED\iawp()->get_option('iawp_email_report_time', 9), 'emails' => \IAWPSCOPED\iawp()->get_option('iawp_email_report_email_addresses', []), 'default_colors' => $defaults, 'input_default' => $input_defaults]);
32	}
33	$ips = \IAWPSCOPED\iawp()->get_option('iawp_blocked_ips', []);
34	echo \IAWPSCOPED\iawp_blade()->run('settings.block-ips', ['current_ip' => Request::ip(), 'ip_is_blocked' => Request::is_ip_address_blocked($ips), 'ips' => $ips]);
35	echo \IAWPSCOPED\iawp_blade()->run('settings.block-by-role', ['roles' => \wp_roles()->roles, 'blocked' => \IAWPSCOPED\iawp()->get_option('iawp_blocked_roles', [])]);
36	echo \IAWPSCOPED\iawp_blade()->run('settings.capabilities', ['editable_roles' => $this->get_editable_roles(), 'capabilities' => \IAWP\Capability_Manager::all_capabilities()]);
37	echo \IAWPSCOPED\iawp_blade()->run('settings.view-counter');
38	echo \IAWPSCOPED\iawp_blade()->run('settings.export-reports', ['report_finder' => new \IAWP\Report_Finder()]);
39	echo \IAWPSCOPED\iawp_blade()->run('settings.export-data');
40	echo \IAWPSCOPED\iawp_blade()->run('settings.delete', ['site_name' => \get_bloginfo('name'), 'site_url' => \site_url()]);
41	}
42	public function register_settings()
43	{
44	\add_settings_section('iawp-settings-section', \esc_html__('Basic Settings', 'independent-analytics'), function () {
45	}, 'independent-analytics-settings');
46	$args = ['type' => 'boolean', 'default' => \false, 'sanitize_callback' => 'rest_sanitize_boolean'];
47	\register_setting('iawp_settings', 'iawp_dark_mode', $args);
48	\add_settings_field('iawp_dark_mode', \esc_html__('Dark mode', 'independent-analytics'), [$this, 'dark_mode_callback'], 'independent-analytics-settings', 'iawp-settings-section', ['class' => 'dark-mode']);
49	\register_setting('iawp_settings', 'iawp_track_authenticated_users', $args);
50	\add_settings_field('iawp_track_authenticated_users', \esc_html__('Track logged in users', 'independent-analytics'), [$this, 'track_authenticated_users_callback'], 'independent-analytics-settings', 'iawp-settings-section', ['class' => 'logged-in']);
51	\register_setting('iawp_settings', 'iawp_disable_admin_toolbar_analytics', $args);
52	\add_settings_field('iawp_disable_admin_toolbar_analytics', \esc_html__('Admin toolbar stats', 'independent-analytics'), [$this, 'disable_admin_toolbar_analytics_callback'], 'independent-analytics-settings', 'iawp-settings-section');
53	\register_setting('iawp_settings', 'iawp_disable_widget', $args);
54	\add_settings_field('iawp_disable_widget', \esc_html__('Dashboard widget', 'independent-analytics'), [$this, 'disable_widget_callback'], 'independent-analytics-settings', 'iawp-settings-section');
55	\register_setting('iawp_settings', 'iawp_disable_views_column', $args);
56	\add_settings_field('iawp_disable_views_column', \esc_html__('Views column', 'independent-analytics'), [$this, 'disable_views_column_callback'], 'independent-analytics-settings', 'iawp-settings-section');
57	$args = ['type' => 'integer', 'default' => 0, 'sanitize_callback' => 'absint'];
58	\register_setting('iawp_settings', 'iawp_dow', $args);
59	\add_settings_field('iawp_dow', \esc_html__('First day of week', 'independent-analytics'), [$this, 'starting_dow_callback'], 'independent-analytics-settings', 'iawp-settings-section', ['class' => 'dow']);
60	$args = ['type' => 'boolean', 'default' => \false, 'sanitize_callback' => 'rest_sanitize_boolean'];
61	\register_setting('iawp_settings', 'iawp_refresh_salt', $args);
62	\add_settings_field('iawp_refresh_salt', \esc_html__('Salt refresh rate', 'independent-analytics'), [$this, 'refresh_salt_callback'], 'independent-analytics-settings', 'iawp-settings-section', ['class' => 'salt']);
63	}
64	public function dark_mode_callback()
65	{
66	echo \IAWPSCOPED\iawp_blade()->run('settings.dark-mode', ['dark_mode' => \IAWPSCOPED\iawp()->get_option('iawp_dark_mode', \false)]);
67	}
68	public function track_authenticated_users_callback()
69	{
70	echo \IAWPSCOPED\iawp_blade()->run('settings.track-authenticated-users', ['track_authenticated_users' => \IAWPSCOPED\iawp()->get_option('iawp_track_authenticated_users', \false)]);
71	}
72	public function disable_admin_toolbar_analytics_callback()
73	{
74	echo \IAWPSCOPED\iawp_blade()->run('settings.disable-admin-toolbar-analytics', ['value' => \IAWPSCOPED\iawp()->get_option('iawp_disable_admin_toolbar_analytics', \false)]);
75	}
76	public function disable_widget_callback()
77	{
78	echo \IAWPSCOPED\iawp_blade()->run('settings.disable-widget', ['value' => \IAWPSCOPED\iawp()->get_option('iawp_disable_widget', \false)]);
79	}
80	public function disable_views_column_callback() : void
81	{
82	echo \IAWPSCOPED\iawp_blade()->run('settings.disable-views-column', ['value' => \IAWPSCOPED\iawp()->get_option('iawp_disable_views_column', \false)]);
83	}
84	public function starting_dow_callback()
85	{
86	echo \IAWPSCOPED\iawp_blade()->run('settings.first-day-of-week', ['day_of_week' => \IAWPSCOPED\iawp()->get_option('iawp_dow', 0), 'days' => [0 => \esc_html__('Sunday', 'independent-analytics'), 1 => \esc_html__('Monday', 'independent-analytics'), 2 => \esc_html__('Tuesday', 'independent-analytics'), 3 => \esc_html__('Wednesday', 'independent-analytics'), 4 => \esc_html__('Thursday', 'independent-analytics'), 5 => \esc_html__('Friday', 'independent-analytics'), 6 => \esc_html__('Saturday', 'independent-analytics')]]);
87	}
88	public function refresh_salt_callback()
89	{
90	echo \IAWPSCOPED\iawp_blade()->run('settings.refresh-salt', ['refresh_salt' => \IAWPSCOPED\iawp()->get_option('iawp_refresh_salt', \false)]);
91	}
92	public function register_view_counter_settings()
93	{
94	\add_settings_section('iawp-view-counter-settings-section', \esc_html__('Public View Counter', 'independent-analytics'), function () {
95	}, 'independent-analytics-view-counter-settings');
96	$args = ['type' => 'boolean', 'default' => \false, 'sanitize_callback' => 'rest_sanitize_boolean'];
97	\register_setting('iawp_view_counter_settings', 'iawp_view_counter_enable', $args);
98	\add_settings_field('iawp_view_counter_enable', \esc_html__('Enable the view counter', 'independent-analytics'), [$this, 'view_counter_enable_callback'], 'independent-analytics-view-counter-settings', 'iawp-view-counter-settings-section', ['class' => 'enable']);
99	$args = ['type' => 'array', 'default' => [], 'sanitize_callback' => [$this, 'sanitize_view_counter_post_types']];
100	\register_setting('iawp_view_counter_settings', 'iawp_view_counter_post_types', $args);
101	\add_settings_field('iawp_view_counter_post_types', \esc_html__('Display on these post types', 'independent-analytics'), [$this, 'view_counter_post_types_callback'], 'independent-analytics-view-counter-settings', 'iawp-view-counter-settings-section', ['class' => 'post-types']);
102	// Position
103	$args = ['type' => 'string', 'default' => 'after', 'sanitize_callback' => [$this, 'sanitize_view_counter_position']];
104	\register_setting('iawp_view_counter_settings', 'iawp_view_counter_position', $args);
105	\add_settings_field('iawp_view_counter_position', \esc_html__('Show it in this location', 'independent-analytics'), [$this, 'view_counter_position_callback'], 'independent-analytics-view-counter-settings', 'iawp-view-counter-settings-section', ['class' => 'position']);
106	// Views to count
107	\register_setting('iawp_view_counter_settings', 'iawp_view_counter_views_to_count', ['type' => 'string', 'default' => 'total', 'sanitize_callback' => [$this, 'sanitize_view_counter_views_to_count']]);
108	\add_settings_field('iawp_view_counter_views_to_count', \esc_html__('Date range to count views', 'independent-analytics'), [$this, 'view_counter_views_to_count_callback'], 'independent-analytics-view-counter-settings', 'iawp-view-counter-settings-section', ['class' => 'views-to-count']);
109	// Exclude
110	$args = ['type' => 'string', 'default' => '', 'sanitize_callback' => [$this, 'sanitize_view_counter_exclude']];
111	\register_setting('iawp_view_counter_settings', 'iawp_view_counter_exclude', $args);
112	\add_settings_field('iawp_view_counter_exclude', \esc_html__('Exclude these pages', 'independent-analytics'), [$this, 'view_counter_exclude_callback'], 'independent-analytics-view-counter-settings', 'iawp-view-counter-settings-section', ['class' => 'exclude']);
113	// Label
114	$default = \function_exists('IAWPSCOPED\\pll__') ? pll__('Views:', 'independent-analytics') : \__('Views:', 'independent-analytics');
115	$args = ['type' => 'string', 'default' => $default, 'sanitize_callback' => 'sanitize_text_field'];
116	\register_setting('iawp_view_counter_settings', 'iawp_view_counter_label', $args);
117	\add_settings_field('iawp_view_counter_label', \esc_html__('Edit the label', 'independent-analytics'), [$this, 'view_counter_label_callback'], 'independent-analytics-view-counter-settings', 'iawp-view-counter-settings-section', ['class' => 'counter-label']);
118	// Icon
119	$args = ['type' => 'boolean', 'default' => \true, 'sanitize_callback' => 'rest_sanitize_boolean'];
120	\register_setting('iawp_view_counter_settings', 'iawp_view_counter_icon', $args);
121	\add_settings_field('iawp_view_counter_icon', \esc_html__('Display the icon', 'independent-analytics'), [$this, 'view_counter_icon_callback'], 'independent-analytics-view-counter-settings', 'iawp-view-counter-settings-section', ['class' => 'icon']);
122	// Private
123	\register_setting('iawp_view_counter_settings', 'iawp_view_counter_private', ['type' => 'boolean', 'default' => \false, 'sanitize_callback' => 'rest_sanitize_boolean']);
124	\add_settings_field('iawp_view_counter_private', \esc_html__('Make the view counter private?', 'independent-analytics'), [$this, 'view_counter_private_callback'], 'independent-analytics-view-counter-settings', 'iawp-view-counter-settings-section', ['class' => 'private']);
125	// Allow manual adjustment
126	\register_setting('iawp_view_counter_settings', 'iawp_view_counter_manual_adjustment', ['type' => 'boolean', 'default' => \false, 'sanitize_callback' => 'rest_sanitize_boolean']);
127	\add_settings_field('iawp_view_counter_manual_adjustment', \esc_html__('Allow manual adjustment?', 'independent-analytics'), [$this, 'view_counter_manual_adjustment_callback'], 'independent-analytics-view-counter-settings', 'iawp-view-counter-settings-section', ['class' => 'manual-adjustment']);
128	}
129	public function view_counter_enable_callback()
130	{
131	echo \IAWPSCOPED\iawp_blade()->run('settings.view-counter.enable', ['enable' => \IAWPSCOPED\iawp()->get_option('iawp_view_counter_enable', \false)]);
132	}
133	public function view_counter_post_types_callback()
134	{
135	$site_post_types = \get_post_types(['public' => \true], 'objects');
136	$counter = 0;
137	foreach ($site_post_types as $post_type) {
138	echo \IAWPSCOPED\iawp_blade()->run('settings.view-counter.post-types', ['counter' => $counter, 'post_type' => $post_type, 'saved' => \IAWPSCOPED\iawp()->get_option('iawp_view_counter_post_types', [])]);
139	$counter++;
140	}
141	?>
142	<p class="description"><?php
143	\esc_html_e('Uncheck all boxes to only show view count manually. See shortcode documentation below for details.', 'independent-analytics');
144	?></p>
145	<?php
146	}
147	public function view_counter_position_callback()
148	{
149	echo \IAWPSCOPED\iawp_blade()->run('settings.view-counter.position', ['position' => \IAWPSCOPED\iawp()->get_option('iawp_view_counter_position', 'after')]);
150	}
151	public function view_counter_views_to_count_callback()
152	{
153	echo \IAWPSCOPED\iawp_blade()->run('settings.view-counter.views-to-count', ['value' => \IAWPSCOPED\iawp()->get_option('iawp_view_counter_views_to_count', 'total')]);
154	}
155	public function view_counter_exclude_callback()
156	{
157	echo \IAWPSCOPED\iawp_blade()->run('settings.view-counter.exclude', ['exclude' => \IAWPSCOPED\iawp()->get_option('iawp_view_counter_exclude', '')]);
158	}
159	public function view_counter_label_callback()
160	{
161	$default = \function_exists('IAWPSCOPED\\pll__') ? pll__('Views:', 'independent-analytics') : \__('Views:', 'independent-analytics');
162	echo \IAWPSCOPED\iawp_blade()->run('settings.view-counter.label', ['label' => \IAWPSCOPED\iawp()->get_option('iawp_view_counter_label', $default)]);
163	}
164	public function view_counter_icon_callback()
165	{
166	echo \IAWPSCOPED\iawp_blade()->run('settings.view-counter.icon', ['icon' => \get_option('iawp_view_counter_icon', \true)]);
167	}
168	public function view_counter_private_callback()
169	{
170	echo \IAWPSCOPED\iawp_blade()->run('settings.view-counter.private', ['private' => \IAWPSCOPED\iawp()->get_option('iawp_view_counter_private', \false)]);
171	}
172	public function view_counter_manual_adjustment_callback()
173	{
174	echo \IAWPSCOPED\iawp_blade()->run('settings.view-counter.manual-adjustment', ['value' => \IAWPSCOPED\iawp()->get_option('iawp_view_counter_manual_adjustment', \false)]);
175	}
176	public function register_blocked_ip_settings()
177	{
178	\add_settings_section('iawp-blocked-ips-settings-section', \esc_html__('Block IP Addresses', 'independent-analytics'), function () {
179	}, 'iawp-blocked-ips-settings');
180	$args = ['type' => 'array', 'default' => [], 'sanitize_callback' => [$this, 'sanitize_blocked_ips']];
181	\register_setting('iawp_blocked_ip_settings', 'iawp_blocked_ips', $args);
182	}
183	public function register_email_report_settings()
184	{
185	\add_settings_section('iawp-email-report-settings-section', \esc_html__('Scheduled Email Reports', 'independent-analytics'), function () {
186	}, 'iawp-email-report-settings');
187	\register_setting('iawp_email_report_settings', 'iawp_email_report_interval', ['type' => 'string', 'default' => 'monthly', 'sanitize_callback' => [$this, 'sanitize_email_report_interval']]);
188	\register_setting('iawp_email_report_settings', 'iawp_email_report_time', ['type' => 'number', 'default' => 9, 'sanitize_callback' => [$this, 'sanitize_email_report_time']]);
189	\register_setting('iawp_email_report_settings', 'iawp_email_report_email_addresses', ['type' => 'array', 'default' => [], 'sanitize_callback' => [$this, 'sanitize_email_addresses']]);
190	\register_setting('iawp_email_report_settings', 'iawp_email_report_colors', ['type' => 'array', 'default' => $this->email_report_colors(), 'sanitize_callback' => [$this, 'sanitize_email_report_colors']]);
191	}
192	public function register_block_by_role_settings()
193	{
194	\add_settings_section('iawp-block-by-role-settings-section', \esc_html__('Block by User Role', 'independent-analytics'), function () {
195	}, 'iawp-block-by-role-settings');
196	$args = ['type' => 'array', 'default' => [], 'sanitize_callback' => [$this, 'sanitize_blocked_roles']];
197	\register_setting('iawp_block_by_role_settings', 'iawp_blocked_roles', $args);
198	}
199	public function sanitize_view_counter_post_types($user_input)
200	{
201	if (\is_null($user_input)) {
202	return [];
203	}
204	$site_post_types = \get_post_types(['public' => \true]);
205	$to_save = [];
206	foreach ($user_input as $post_type) {
207	if (\in_array($post_type, $site_post_types)) {
208	$to_save[] = $post_type;
209	}
210	}
211	return $to_save;
212	}
213	public function sanitize_view_counter_position($user_input)
214	{
215	if (\in_array($user_input, ['before', 'after', 'both'])) {
216	return $user_input;
217	} else {
218	return 'after';
219	}
220	}
221	public function sanitize_view_counter_views_to_count($user_input)
222	{
223	if (\in_array($user_input, ['total', 'today', 'yesterday', 'this_week', 'last_week', 'last_seven', 'last_thirty', 'last_sixty', 'last_ninety', 'this_month', 'last_month', 'last_three_months', 'last_six_months', 'last_twelve_months', 'this_year', 'last_year'])) {
224	return $user_input;
225	} else {
226	return 'total';
227	}
228	}
229	public function sanitize_view_counter_exclude($user_input)
230	{
231	$user_input = \explode(',', $user_input);
232	$to_save = [];
233	foreach ($user_input as $id) {
234	$save = \absint($id);
235	if ($save != 0) {
236	$to_save[] = $save;
237	}
238	}
239	$to_save = \implode(',', $to_save);
240	return $to_save;
241	}
242	public function sanitize_blocked_ips($user_input)
243	{
244	$to_save = [];
245	foreach ($user_input as $ip) {
246	// Limit to two wildcards
247	if (\substr_count($ip, '*') > 2) {
248	continue;
249	}
250	// If it's safe with wildcard replacements, it's safe with them
251	$safe_replacement = String_Util::str_contains($ip, '.') ? '172' : '2601';
252	$wildcards_replaced = \str_replace('*', $safe_replacement, $ip);
253	if (\filter_var($wildcards_replaced, \FILTER_VALIDATE_IP)) {
254	$to_save[] = $ip;
255	}
256	}
257	return $to_save;
258	}
259	public function sanitize_email_addresses($emails)
260	{
261	$to_save = [];
262	foreach ($emails as $email) {
263	$cleaned = \sanitize_email($email);
264	if (\is_email($cleaned)) {
265	$to_save[] = $cleaned;
266	}
267	}
268	return $to_save;
269	}
270	public function sanitize_email_report_interval($input)
271	{
272	if (\in_array($input, ['monthly', 'weekly', 'daily'])) {
273	return $input;
274	} else {
275	return 'monthly';
276	}
277	}
278	public function sanitize_email_report_time($user_time)
279	{
280	$accepted_times = [];
281	for ($i = 0; $i < 24; $i++) {
282	$accepted_times[] = $i;
283	}
284	if (\in_array($user_time, $accepted_times)) {
285	return $user_time;
286	} else {
287	return 9;
288	}
289	}
290	public function sanitize_blocked_roles($blocked_roles)
291	{
292	$to_save = [];
293	$user_roles = \array_keys(\wp_roles()->roles);
294	foreach ($blocked_roles as $blocked) {
295	if (\in_array($blocked, $user_roles)) {
296	$to_save[] = $blocked;
297	}
298	}
299	return $to_save;
300	}
301	public function sanitize_email_report_colors($colors)
302	{
303	$to_save = [];
304	// No idea why WP sometimes returns an array, so this is for my sanity
305	if (\is_string($colors)) {
306	$colors = \explode(',', $colors);
307	}
308	foreach ($colors as $color) {
309	$to_save[] = \sanitize_hex_color($color);
310	}
311	return $to_save;
312	}
313	/**
314	* @return array
315	*/
316	private function get_editable_roles() : array
317	{
318	$editable_roles = [];
319	$wp_roles = \wp_roles()->roles;
320	\array_walk($wp_roles, function ($role, $role_key) use(&$editable_roles) {
321	if ($role_key === 'administrator') {
322	return;
323	}
324	$read_only_access = $role['capabilities']['iawp_read_only_access'] ?? \false;
325	$full_access = $role['capabilities']['iawp_full_access'] ?? \false;
326	$editable_roles[] = ['key' => $role_key, 'name' => $role['name'], 'iawp_no_access' => !$read_only_access && !$full_access, 'iawp_read_only_access' => $read_only_access, 'iawp_full_access' => $full_access];
327	});
328	return $editable_roles;
329	}
330	private function email_report_colors()
331	{
332	return ['#5123a0', '#fafafa', '#3a1e6b', '#fafafa', '#5123a0', '#a985e6', '#ece9f2', '#f7f5fa', '#ece9f2', '#dedae6'];
333	}
334	}
335