class.jetpack-display-posts-widget-base.php
2 years ago
class.jetpack-display-posts-widget.php
3 years ago
style.css
7 years ago
class.jetpack-display-posts-widget.php
279 lines
| 1 | <?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName |
| 2 | |
| 3 | use Automattic\Jetpack\Status; |
| 4 | |
| 5 | /** |
| 6 | * Display a list of recent posts from a WordPress.com or Jetpack-enabled blog. |
| 7 | */ |
| 8 | class Jetpack_Display_Posts_Widget extends Jetpack_Display_Posts_Widget__Base { |
| 9 | /** |
| 10 | * Widget options key prefix. |
| 11 | * |
| 12 | * @var string |
| 13 | */ |
| 14 | public $widget_options_key_prefix = 'display_posts_site_data_'; |
| 15 | |
| 16 | /** |
| 17 | * The name of the cron that will update widget data. |
| 18 | * |
| 19 | * @var string |
| 20 | */ |
| 21 | public static $cron_name = 'jetpack_display_posts_widget_cron_update'; |
| 22 | |
| 23 | // DATA STORE. |
| 24 | |
| 25 | /** |
| 26 | * Gets blog data from the cache. |
| 27 | * |
| 28 | * @param string $site Site. |
| 29 | * |
| 30 | * @return array|WP_Error |
| 31 | */ |
| 32 | public function get_blog_data( $site ) { |
| 33 | // Load from cache, if nothing return an error. |
| 34 | $site_hash = $this->get_site_hash( $site ); |
| 35 | |
| 36 | $cached_data = $this->wp_get_option( $this->widget_options_key_prefix . $site_hash ); |
| 37 | |
| 38 | /** |
| 39 | * If the cache is empty, return an empty_cache error. |
| 40 | */ |
| 41 | if ( false === $cached_data ) { |
| 42 | return new WP_Error( |
| 43 | 'empty_cache', |
| 44 | __( 'Information about this blog is currently being retrieved.', 'jetpack' ) |
| 45 | ); |
| 46 | } |
| 47 | |
| 48 | return $cached_data; |
| 49 | } |
| 50 | |
| 51 | /** |
| 52 | * Update a widget instance. |
| 53 | * |
| 54 | * @param string $site The site to fetch the latest data for. |
| 55 | * |
| 56 | * @return array - the new data |
| 57 | */ |
| 58 | public function update_instance( $site ) { |
| 59 | |
| 60 | /** |
| 61 | * Fetch current information for a site. |
| 62 | */ |
| 63 | $site_hash = $this->get_site_hash( $site ); |
| 64 | |
| 65 | $option_key = $this->widget_options_key_prefix . $site_hash; |
| 66 | |
| 67 | $instance_data = $this->wp_get_option( $option_key ); |
| 68 | |
| 69 | /** |
| 70 | * Fetch blog data and save it in $instance_data. |
| 71 | */ |
| 72 | $new_data = $this->fetch_blog_data( $site, $instance_data ); |
| 73 | |
| 74 | /** |
| 75 | * If the option doesn't exist yet - create a new option |
| 76 | */ |
| 77 | if ( false === $instance_data ) { |
| 78 | $this->wp_add_option( $option_key, $new_data ); |
| 79 | } else { |
| 80 | $this->wp_update_option( $option_key, $new_data ); |
| 81 | } |
| 82 | |
| 83 | return $new_data; |
| 84 | } |
| 85 | |
| 86 | // WIDGET API. |
| 87 | |
| 88 | /** |
| 89 | * Widget update function. |
| 90 | * |
| 91 | * @param array $new_instance New instance widget settings. |
| 92 | * @param array $old_instance Old instance widget settings. |
| 93 | */ |
| 94 | public function update( $new_instance, $old_instance ) { |
| 95 | $instance = parent::update( $new_instance, $old_instance ); |
| 96 | |
| 97 | /** |
| 98 | * Forcefully activate the update cron when saving widget instance. |
| 99 | * |
| 100 | * So we can be sure that it will be running later. |
| 101 | */ |
| 102 | $this->activate_cron(); |
| 103 | |
| 104 | return $instance; |
| 105 | } |
| 106 | |
| 107 | // CRON. |
| 108 | |
| 109 | /** |
| 110 | * Activates widget update cron task. |
| 111 | */ |
| 112 | public static function activate_cron() { |
| 113 | if ( ! wp_next_scheduled( self::$cron_name ) ) { |
| 114 | wp_schedule_event( time(), 'minutes_10', self::$cron_name ); |
| 115 | } |
| 116 | } |
| 117 | |
| 118 | /** |
| 119 | * Deactivates widget update cron task. |
| 120 | * |
| 121 | * This is a wrapper over the static method as it provides some syntactic sugar. |
| 122 | */ |
| 123 | public function deactivate_cron() { |
| 124 | self::deactivate_cron_static(); |
| 125 | } |
| 126 | |
| 127 | /** |
| 128 | * Deactivates widget update cron task. |
| 129 | */ |
| 130 | public static function deactivate_cron_static() { |
| 131 | $next_scheduled_time = wp_next_scheduled( self::$cron_name ); |
| 132 | wp_unschedule_event( $next_scheduled_time, self::$cron_name ); |
| 133 | } |
| 134 | |
| 135 | /** |
| 136 | * Checks if the update cron should be running and returns appropriate result. |
| 137 | * |
| 138 | * @return bool If the cron should be running or not. |
| 139 | */ |
| 140 | public function should_cron_be_running() { |
| 141 | /** |
| 142 | * The cron doesn't need to run empty loops. |
| 143 | */ |
| 144 | $widget_instances = $this->get_instances_sites(); |
| 145 | |
| 146 | if ( empty( $widget_instances ) || ! is_array( $widget_instances ) ) { |
| 147 | return false; |
| 148 | } |
| 149 | |
| 150 | if ( ! defined( 'IS_WPCOM' ) || ! IS_WPCOM ) { |
| 151 | /** |
| 152 | * If Jetpack is not active or in offline mode, we don't want to update widget data. |
| 153 | */ |
| 154 | if ( ! Jetpack::is_connection_ready() && ! ( new Status() )->is_offline_mode() ) { |
| 155 | return false; |
| 156 | } |
| 157 | |
| 158 | /** |
| 159 | * If Extra Sidebar Widgets module is not active, we don't need to update widget data. |
| 160 | */ |
| 161 | if ( ! Jetpack::is_module_active( 'widgets' ) ) { |
| 162 | return false; |
| 163 | } |
| 164 | } |
| 165 | |
| 166 | /** |
| 167 | * If none of the above checks failed, then we definitely want to update widget data. |
| 168 | */ |
| 169 | return true; |
| 170 | } |
| 171 | |
| 172 | /** |
| 173 | * Main cron code. Updates all instances of the widget. |
| 174 | * |
| 175 | * @return bool |
| 176 | */ |
| 177 | public function cron_task() { |
| 178 | |
| 179 | /** |
| 180 | * If the cron should not be running, disable it. |
| 181 | */ |
| 182 | if ( false === $this->should_cron_be_running() ) { |
| 183 | return true; |
| 184 | } |
| 185 | |
| 186 | $instances_to_update = $this->get_instances_sites(); |
| 187 | |
| 188 | /** |
| 189 | * If no instances are found to be updated - stop. |
| 190 | */ |
| 191 | if ( empty( $instances_to_update ) || ! is_array( $instances_to_update ) ) { |
| 192 | return true; |
| 193 | } |
| 194 | |
| 195 | foreach ( $instances_to_update as $site_url ) { |
| 196 | $this->update_instance( $site_url ); |
| 197 | } |
| 198 | |
| 199 | return true; |
| 200 | } |
| 201 | |
| 202 | /** |
| 203 | * Get a list of unique sites from all instances of the widget. |
| 204 | * |
| 205 | * @return array|bool |
| 206 | */ |
| 207 | public function get_instances_sites() { |
| 208 | |
| 209 | $widget_settings = $this->wp_get_option( 'widget_jetpack_display_posts_widget' ); |
| 210 | |
| 211 | /** |
| 212 | * If the widget still hasn't been added anywhere, the config will not be present. |
| 213 | * |
| 214 | * In such case we don't want to continue execution. |
| 215 | */ |
| 216 | if ( false === $widget_settings || ! is_array( $widget_settings ) ) { |
| 217 | return false; |
| 218 | } |
| 219 | |
| 220 | $urls = array(); |
| 221 | |
| 222 | foreach ( $widget_settings as $widget_instance_data ) { |
| 223 | if ( isset( $widget_instance_data['url'] ) && ! empty( $widget_instance_data['url'] ) ) { |
| 224 | $urls[] = $widget_instance_data['url']; |
| 225 | } |
| 226 | } |
| 227 | |
| 228 | /** |
| 229 | * Make sure only unique URLs are returned. |
| 230 | */ |
| 231 | $urls = array_unique( $urls ); |
| 232 | |
| 233 | return $urls; |
| 234 | } |
| 235 | |
| 236 | // MOCKABLES. |
| 237 | |
| 238 | /** |
| 239 | * This is just to make method mocks in the unit tests easier. |
| 240 | * |
| 241 | * @param string $param Option key to get. |
| 242 | * |
| 243 | * @return mixed |
| 244 | * |
| 245 | * @codeCoverageIgnore |
| 246 | */ |
| 247 | public function wp_get_option( $param ) { |
| 248 | return get_option( $param ); |
| 249 | } |
| 250 | |
| 251 | /** |
| 252 | * This is just to make method mocks in the unit tests easier. |
| 253 | * |
| 254 | * @param string $option_name Option name to be added. |
| 255 | * @param mixed $option_value Option value. |
| 256 | * |
| 257 | * @return mixed |
| 258 | * |
| 259 | * @codeCoverageIgnore |
| 260 | */ |
| 261 | public function wp_add_option( $option_name, $option_value ) { |
| 262 | return add_option( $option_name, $option_value ); |
| 263 | } |
| 264 | |
| 265 | /** |
| 266 | * This is just to make method mocks in the unit tests easier. |
| 267 | * |
| 268 | * @param string $option_name Option name to be updated. |
| 269 | * @param mixed $option_value Option value. |
| 270 | * |
| 271 | * @return mixed |
| 272 | * |
| 273 | * @codeCoverageIgnore |
| 274 | */ |
| 275 | public function wp_update_option( $option_name, $option_value ) { |
| 276 | return update_option( $option_name, $option_value ); |
| 277 | } |
| 278 | } |
| 279 |