Dashboard.php — Matomo Analytics – Powerful, Privacy-First Insights for WordPress 5.12.1

matomo / classes / WpMatomo / Admin / Dashboard.php

matomo / classes / WpMatomo / Admin Last commit date

Dashboard.php

148 lines

1	<?php
2	/**
3	* Matomo - free/libre analytics platform
4	*
5	* @link https://matomo.org
6	* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
7	* @package matomo
8	*/
9
10	namespace WpMatomo\Admin;
11
12	use Exception;
13	use WpMatomo\Capabilities;
14	use WpMatomo\Feature;
15	use WpMatomo\Logger;
16	use WpMatomo\Report\Dates;
17	use WpMatomo\Report\Metadata;
18	use WpMatomo\Report\Renderer;
19	use WpMatomo\Uninstaller;
20
21	if ( ! defined( 'ABSPATH' ) ) {
22	exit; // if accessed directly
23	}
24
25	class Dashboard extends Feature {
26	const DASHBOARD_USER_OPTION = 'matomo_dashboard_widgets';
27
28	public function is_active() {
29	return is_admin();
30	}
31
32	public function register_hooks() {
33	add_action( 'wp_dashboard_setup', [ $this, 'add_dashboard_widgets' ] );
34	}
35
36	public function add_dashboard_widgets() {
37	$widgets = $this->get_widgets();
38	if ( ! empty( $widgets ) && is_array( $widgets ) && current_user_can( Capabilities::KEY_VIEW ) ) {
39	do_action( 'matomo_load_chartjs' );
40	foreach ( $widgets as $widget ) {
41	try {
42	$widget_meta = $this->is_valid_widget( $widget['unique_id'], $widget['date'] );
43	if ( ! empty( $widget_meta['report']['name'] ) ) {
44	$id = 'matomo_dashboard_widget_' . $widget['unique_id'] . '_' . $widget['date'];
45
46	$title = $widget_meta['report']['name'] . ' - ' . $widget_meta['date'] . ' - Matomo';
47
48	wp_add_dashboard_widget(
49	$id,
50	esc_html( $title ),
51	function () use ( $widget ) {
52	$renderer = new Renderer();
53	// do not escape the content, we want the HTML
54	// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
55	echo $renderer->show_report(
56	[
57	// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
58	'unique_id' => $widget['unique_id'],
59	// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
60	'report_date' => $widget['date'],
61	'limit' => 10,
62	]
63	);
64	}
65	);
66	}
67	} catch ( Exception $e ) {
68	// dont want to break dashboard if there is any issue with matomo ... eg in case bootstrap fails
69	// or is reinstalled but matomo not yet fully installed etc
70	$logger = new Logger();
71	$logger->log( sprintf( 'Failed to add Matomo widget %s to dashboard: %s', wp_json_encode( $widget ), $e->getMessage() ) );
72	}
73	}
74	}
75	}
76
77	public function get_widgets() {
78	$meta = get_user_meta( get_current_user_id(), self::DASHBOARD_USER_OPTION, true );
79	if ( empty( $meta ) ) {
80	$meta = [];
81	}
82
83	return $meta;
84	}
85
86	public function is_valid_widget( $unique_id, $date ) {
87	if ( empty( $unique_id ) \|\| empty( $date ) ) {
88	return false;
89	}
90
91	$metadata = new Metadata();
92	$report = $metadata->find_report_by_unique_id( $unique_id );
93
94	if ( empty( $report ) ) {
95	return false;
96	}
97
98	$report_dates_obj = new Dates();
99	$report_dates = $report_dates_obj->get_supported_dates();
100
101	if ( empty( $report_dates[ $date ] ) ) {
102	return false;
103	}
104
105	return [
106	'report' => $report,
107	'date' => $report_dates[ $date ],
108	];
109	}
110
111	public function has_widget( $report_unique_id, $report_date ) {
112	$widgets = $this->get_widgets();
113	foreach ( $widgets as $index => $widget ) {
114	if ( $widget['unique_id'] === $report_unique_id && $widget['date'] === $report_date ) {
115	return true;
116	}
117	}
118
119	return false;
120	}
121
122	public function toggle_widget( $report_unique_id, $report_date ) {
123	$widgets = $this->get_widgets();
124	foreach ( $widgets as $index => $widget ) {
125	if ( $widget['unique_id'] === $report_unique_id && $widget['date'] === $report_date ) {
126	unset( $widgets[ $index ] );
127	$this->set_widgets( array_values( $widgets ) );
128
129	return;
130	}
131	}
132	$widgets[] = [
133	'unique_id' => $report_unique_id,
134	'date' => $report_date,
135	];
136
137	$this->set_widgets( $widgets );
138	}
139
140	private function set_widgets( $widgets ) {
141	update_user_meta( get_current_user_id(), self::DASHBOARD_USER_OPTION, $widgets );
142	}
143
144	public function uninstall() {
145	Uninstaller::uninstall_user_meta( self::DASHBOARD_USER_OPTION );
146	}
147	}
148