Settings.php — Independent Analytics – WordPress Analytics Plugin 2.4.2

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 Filter_Lists 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 Email_Chart.php 2 years ago Email_Reports.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 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

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