jetpack / modules / monitor.php

monitor.php in Jetpack – WP Security, Backup, Speed, & Growth 14.8, at modules/monitor.php

135 lines 3.5 KB

Raw Download Zip

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Module Name: Downtime Monitor
4	* Module Description: Get instant alerts if your site goes down and know when it’s back online.
5	* Sort Order: 28
6	* Recommendation Order: 10
7	* First Introduced: 2.6
8	* Requires Connection: Yes
9	* Requires User Connection: Yes
10	* Auto Activate: No
11	* Module Tags: Recommended
12	* Feature: Security
13	* Additional Search Queries: monitor, uptime, downtime, monitoring, maintenance, maintenance mode, offline, site is down, site down, down, repair, error
14	*
15	* @package automattic/jetpack
16	*/
17
18	use Automattic\Jetpack\Connection\Manager as Connection_Manager;
19
20	/**
21	* Class Jetpack_Monitor
22	*/
23	class Jetpack_Monitor {
24
25	/**
26	* Name of the module.
27	*
28	* @var string Name of module.
29	*/
30	public $module = 'monitor';
31
32	/**
33	* Constructor.
34	*/
35	public function __construct() {
36	add_action( 'jetpack_modules_loaded', array( $this, 'jetpack_modules_loaded' ) );
37	add_action( 'jetpack_activate_module_monitor', array( $this, 'activate_module' ) );
38	}
39
40	/**
41	* Runs upon module activation.
42	*
43	* @return void
44	*/
45	public function activate_module() {
46	if ( ( new Connection_Manager( 'jetpack' ) )->is_user_connected() ) {
47	self::update_option_receive_jetpack_monitor_notification( true );
48	}
49	}
50
51	/**
52	* Runs on the jetpack_modules_loaded hook to enable configuation.
53	*
54	* @return void
55	*/
56	public function jetpack_modules_loaded() {
57	Jetpack::enable_module_configurable( $this->module );
58	}
59
60	/**
61	* Whether to receive the notifications.
62	*
63	* @param bool $value `true` to enable notifications, `false` to disable them.
64	*
65	* @return bool
66	*/
67	public function update_option_receive_jetpack_monitor_notification( $value ) {
68	$xml = new Jetpack_IXR_Client(
69	array(
70	'user_id' => get_current_user_id(),
71	)
72	);
73	$xml->query( 'jetpack.monitor.setNotifications', (bool) $value );
74
75	if ( $xml->isError() ) {
76	wp_die( sprintf( '%s: %s', esc_html( $xml->getErrorCode() ), esc_html( $xml->getErrorMessage() ) ) );
77	}
78
79	// To be used only in Jetpack_Core_Json_Api_Endpoints::get_remote_value.
80	update_option( 'monitor_receive_notifications', (bool) $value );
81
82	return true;
83	}
84
85	/**
86	* Checks the status of notifications for current Jetpack site user.
87	*
88	* @since 2.8
89	* @since 4.1.0 New parameter $die_on_error.
90	*
91	* @param bool $die_on_error Whether to issue a wp_die when an error occurs or return a WP_Error object.
92	*
93	* @return boolean\|WP_Error
94	*/
95	public static function user_receives_notifications( $die_on_error = true ) {
96	$xml = new Jetpack_IXR_Client(
97	array(
98	'user_id' => get_current_user_id(),
99	)
100	);
101	$xml->query( 'jetpack.monitor.isUserInNotifications' );
102
103	if ( $xml->isError() ) {
104	if ( $die_on_error ) {
105	wp_die( sprintf( '%s: %s', esc_html( $xml->getErrorCode() ), esc_html( $xml->getErrorMessage() ) ), 400 );
106	} else {
107	return new WP_Error( $xml->getErrorCode(), $xml->getErrorMessage(), array( 'status' => 400 ) );
108	}
109	}
110	return $xml->getResponse();
111	}
112
113	/**
114	* Returns date of the last downtime.
115	*
116	* @since 4.0.0
117	* @return string date in YYYY-MM-DD HH:mm:ss format
118	*/
119	public function monitor_get_last_downtime() {
120	$xml = new Jetpack_IXR_Client();
121
122	$xml->query( 'jetpack.monitor.getLastDowntime' );
123
124	if ( $xml->isError() ) {
125	return new WP_Error( 'monitor-downtime', $xml->getErrorMessage() );
126	}
127
128	set_transient( 'monitor_last_downtime', $xml->getResponse(), 10 * MINUTE_IN_SECONDS );
129
130	return $xml->getResponse();
131	}
132	}
133
134	new Jetpack_Monitor();
135