blocks
2 years ago
build
2 years ago
fonts
3 years ago
genericons
6 years ago
lib
2 years ago
social-logos
2 years ago
accessible-focus.js
6 years ago
blogging-prompts.php
2 years ago
class.jetpack-provision.php
2 years ago
crowdsignal-shortcode.js
3 years ago
crowdsignal-survey.js
6 years ago
facebook-embed.js
4 years ago
gallery-settings.js
6 years ago
genericons.php
5 years ago
jetpack-admin.js
3 years ago
jetpack-deactivate-dialog.js
6 years ago
jetpack-modules.js
3 years ago
jetpack-modules.models.js
3 years ago
jetpack-modules.views.js
3 years ago
jetpack-server-sandbox.php
4 years ago
polldaddy-shortcode.js
3 years ago
social-logos.php
3 years ago
twitter-timeline.js
6 years ago
blogging-prompts.php
269 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Used by the blogging prompt feature. |
| 4 | * |
| 5 | * @package automattic/jetpack |
| 6 | */ |
| 7 | |
| 8 | /** |
| 9 | * Hooked functions. |
| 10 | */ |
| 11 | |
| 12 | /** |
| 13 | * Adds the blogging prompt key post meta to the list of allowed post meta to be updated by rest api. |
| 14 | * |
| 15 | * @param array $keys Array of post meta keys that are allowed public metadata. |
| 16 | * |
| 17 | * @return array |
| 18 | */ |
| 19 | function jetpack_blogging_prompts_add_meta_data( $keys ) { |
| 20 | $keys[] = '_jetpack_blogging_prompt_key'; |
| 21 | return $keys; |
| 22 | } |
| 23 | |
| 24 | add_filter( 'rest_api_allowed_public_metadata', 'jetpack_blogging_prompts_add_meta_data' ); |
| 25 | |
| 26 | /** |
| 27 | * Sets up a new post as an answer to a blogging prompt. |
| 28 | * |
| 29 | * When we know a user is explicitly answering a prompt, pre-populate the post meta to mark the post as a prompt response, |
| 30 | * in case they decide to remove the block from the post content, preventing they meta from being added later. |
| 31 | * |
| 32 | * Called on `wp_insert_post` hook. |
| 33 | * |
| 34 | * @param int $post_id ID of post being inserted. |
| 35 | * @return void |
| 36 | */ |
| 37 | function jetpack_setup_blogging_prompt_response( $post_id ) { |
| 38 | // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Clicking a prompt response link can happen from notifications, Calypso, wp-admin, email, etc and only sets up a response post (tag, meta, prompt text); the user must take action to actually publish the post. |
| 39 | $prompt_id = isset( $_GET['answer_prompt'] ) && absint( $_GET['answer_prompt'] ) ? absint( $_GET['answer_prompt'] ) : false; |
| 40 | |
| 41 | if ( ! jetpack_is_new_post_screen() || ! $prompt_id ) { |
| 42 | return; |
| 43 | } |
| 44 | |
| 45 | // Make sure the prompt exists. |
| 46 | $prompt = jetpack_get_blogging_prompt_by_id( $prompt_id ); |
| 47 | |
| 48 | if ( $prompt ) { |
| 49 | update_post_meta( $post_id, '_jetpack_blogging_prompt_key', $prompt_id ); |
| 50 | wp_add_post_tags( $post_id, array( 'dailyprompt', "dailyprompt-$prompt_id" ) ); |
| 51 | if ( array_key_exists( 'bloganuary_id', $prompt ) ) { |
| 52 | wp_add_post_tags( $post_id, array( 'bloganuary', $prompt['bloganuary_id'] ) ); |
| 53 | } |
| 54 | } |
| 55 | } |
| 56 | |
| 57 | add_action( 'wp_insert_post', 'jetpack_setup_blogging_prompt_response' ); |
| 58 | |
| 59 | /** |
| 60 | * When a published posts answers a blogging prompt, store the prompt id in the post meta. |
| 61 | * |
| 62 | * @param int $post_id Post ID. |
| 63 | * @param WP_Post $post Post object. |
| 64 | * @param bool $update Whether this is an existing post being updated. |
| 65 | * @param null|WP_Post $post_before Null for new posts, the WP_Post object prior |
| 66 | * to the update for updated posts. |
| 67 | */ |
| 68 | function jetpack_mark_if_post_answers_blogging_prompt( $post_id, $post, $update, $post_before ) { |
| 69 | if ( ! $post instanceof WP_Post ) { |
| 70 | return; |
| 71 | } |
| 72 | |
| 73 | $post_type = isset( $post->post_type ) ? $post->post_type : null; |
| 74 | $post_content = isset( $post->post_content ) ? $post->post_content : null; |
| 75 | |
| 76 | if ( 'post' !== $post_type || ! $post_content ) { |
| 77 | return; |
| 78 | } |
| 79 | |
| 80 | $new_status = isset( $post->post_status ) ? $post->post_status : null; |
| 81 | $old_status = $post_before && isset( $post_before->post_status ) ? $post_before->post_status : null; |
| 82 | |
| 83 | // Make sure we are publishing a post, and it's not already published. |
| 84 | if ( 'publish' !== $new_status || 'publish' === $old_status ) { |
| 85 | return; |
| 86 | } |
| 87 | |
| 88 | $blocks = parse_blocks( $post->post_content ); |
| 89 | foreach ( $blocks as $block ) { |
| 90 | if ( 'jetpack/blogging-prompt' === $block['blockName'] ) { |
| 91 | $prompt_id = isset( $block['attrs']['promptId'] ) ? absint( $block['attrs']['promptId'] ) : null; |
| 92 | $has_prompt_tag = has_tag( 'dailyprompt', $post ) || ( $prompt_id && has_tag( "dailyprompt-{$prompt_id}", $post ) ); |
| 93 | |
| 94 | if ( $prompt_id && $has_prompt_tag && count( $blocks ) > 1 ) { |
| 95 | update_post_meta( $post->ID, '_jetpack_blogging_prompt_key', $prompt_id ); |
| 96 | } |
| 97 | |
| 98 | break; |
| 99 | } |
| 100 | } |
| 101 | } |
| 102 | |
| 103 | add_action( 'wp_after_insert_post', 'jetpack_mark_if_post_answers_blogging_prompt', 10, 4 ); |
| 104 | |
| 105 | /** |
| 106 | * Utility functions. |
| 107 | */ |
| 108 | |
| 109 | /** |
| 110 | * Retrieve a blogging prompt by prompt ID. |
| 111 | * |
| 112 | * @param int $prompt_id ID of the prompt fetch. |
| 113 | * @return stdClass|null Prompt object or null. |
| 114 | */ |
| 115 | function jetpack_get_blogging_prompt_by_id( $prompt_id ) { |
| 116 | // Ensure the REST API endpoint we need is loaded. |
| 117 | require_once __DIR__ . '/lib/core-api/wpcom-endpoints/class-wpcom-rest-api-v3-endpoint-blogging-prompts.php'; |
| 118 | |
| 119 | $locale = get_locale(); |
| 120 | $route = sprintf( '/wpcom/v3/blogging-prompts/%d', $prompt_id ); |
| 121 | |
| 122 | $request = new WP_REST_Request( 'GET', $route ); |
| 123 | $request->set_param( '_locale', $locale ); |
| 124 | $request->set_param( 'force_year', gmdate( 'Y' ) ); |
| 125 | |
| 126 | $response = rest_do_request( $request ); |
| 127 | |
| 128 | if ( $response->is_error() || WP_Http::OK !== $response->get_status() ) { |
| 129 | return null; |
| 130 | } |
| 131 | |
| 132 | $prompt = $response->get_data(); |
| 133 | |
| 134 | return $prompt; |
| 135 | } |
| 136 | |
| 137 | /** |
| 138 | * Retrieve daily blogging prompts from the wpcom API and cache them. |
| 139 | * |
| 140 | * @param int $time Unix timestamp representing the day for which to get blogging prompts. |
| 141 | * @return stdClass[]|null Array of blogging prompt objects or null. |
| 142 | */ |
| 143 | function jetpack_get_daily_blogging_prompts( $time = 0 ) { |
| 144 | $timestamp = $time ? $time : time(); |
| 145 | |
| 146 | // Include prompts from the previous day, just in case someone has an outdated prompt id. |
| 147 | $day_before = wp_date( 'Y-m-d', $timestamp - DAY_IN_SECONDS ); |
| 148 | $locale = get_locale(); |
| 149 | $transient_key = 'jetpack_blogging_prompt_' . $day_before . '_' . $locale; |
| 150 | $daily_prompts = get_transient( $transient_key ); |
| 151 | |
| 152 | // Return the cached prompt, if we have it. Otherwise fetch it from the API. |
| 153 | if ( false !== $daily_prompts ) { |
| 154 | return $daily_prompts; |
| 155 | } |
| 156 | |
| 157 | $blog_id = \Jetpack_Options::get_option( 'id' ); |
| 158 | $path = '/sites/' . rawurldecode( $blog_id ) . '/blogging-prompts?from=' . rawurldecode( $day_before ) . '&number=10&_locale=' . rawurldecode( $locale ); |
| 159 | |
| 160 | $args = array( |
| 161 | 'headers' => array( |
| 162 | 'Content-Type' => 'application/json', |
| 163 | 'X-Forwarded-For' => ( new \Automattic\Jetpack\Status\Visitor() )->get_ip( true ), |
| 164 | ), |
| 165 | // `method` and `url` are needed for using `WPCOM_API_Direct::do_request` |
| 166 | // `wpcom_json_api_request_as_user` will generate and overwrite these. |
| 167 | 'method' => \WP_REST_Server::READABLE, |
| 168 | 'url' => JETPACK__WPCOM_JSON_API_BASE . '/wpcom/v2' . $path, |
| 169 | ); |
| 170 | |
| 171 | if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) { |
| 172 | // This will load the library, but it may be too late to automatically load any endpoints using WPCOM_API_Direct::register_endpoints. |
| 173 | // In that case, call `wpcom_rest_api_v2_load_plugin_files( 'wp-content/rest-api-plugins/endpoints/blogging-prompts.php' )` |
| 174 | // on the `init` hook to load the blogging-prompts endpoint before calling this function. |
| 175 | require_once WP_CONTENT_DIR . '/lib/wpcom-api-direct/wpcom-api-direct.php'; |
| 176 | $response = \WPCOM_API_Direct::do_request( $args ); |
| 177 | } else { |
| 178 | $response = \Automattic\Jetpack\Connection\Client::wpcom_json_api_request_as_user( $path, 'v2', $args, null, 'wpcom' ); |
| 179 | } |
| 180 | $response_status = wp_remote_retrieve_response_code( $response ); |
| 181 | |
| 182 | if ( is_wp_error( $response ) || $response_status !== \WP_Http::OK ) { |
| 183 | return null; |
| 184 | } |
| 185 | |
| 186 | $body = json_decode( wp_remote_retrieve_body( $response ) ); |
| 187 | |
| 188 | if ( ! $body || ! isset( $body->prompts ) ) { |
| 189 | return null; |
| 190 | } |
| 191 | |
| 192 | $prompts = $body->prompts; |
| 193 | set_transient( $transient_key, $prompts, DAY_IN_SECONDS ); |
| 194 | |
| 195 | return $prompts; |
| 196 | } |
| 197 | |
| 198 | /** |
| 199 | * Determines if the site has publish posts or plans to publish posts. |
| 200 | * |
| 201 | * @return bool |
| 202 | */ |
| 203 | function jetpack_has_or_will_publish_posts() { |
| 204 | // Lets count the posts. |
| 205 | $count_posts_object = wp_count_posts( 'post' ); |
| 206 | $count_posts = (int) $count_posts_object->publish + (int) $count_posts_object->future + (int) $count_posts_object->draft; |
| 207 | |
| 208 | return $count_posts_object->publish >= 2 || $count_posts >= 100; |
| 209 | } |
| 210 | |
| 211 | /** |
| 212 | * Determines if the site has a posts page or shows posts on the front page. |
| 213 | * |
| 214 | * @return bool |
| 215 | */ |
| 216 | function jetpack_has_posts_page() { |
| 217 | // The site is set up to be a blog. |
| 218 | if ( 'posts' === get_option( 'show_on_front' ) ) { |
| 219 | return true; |
| 220 | } |
| 221 | |
| 222 | // There is a page set to show posts. |
| 223 | $is_posts_page_set = (int) get_option( 'page_for_posts' ) > 0; |
| 224 | if ( $is_posts_page_set ) { |
| 225 | return true; |
| 226 | } |
| 227 | |
| 228 | return false; |
| 229 | } |
| 230 | |
| 231 | /** |
| 232 | * Determines if site had the "Write" intent set when created. |
| 233 | * |
| 234 | * @return bool |
| 235 | */ |
| 236 | function jetpack_has_write_intent() { |
| 237 | return 'write' === get_option( 'site_intent', '' ); |
| 238 | } |
| 239 | |
| 240 | /** |
| 241 | * Determines if the current screen (in wp-admin) is creating a new post. |
| 242 | * |
| 243 | * /wp-admin/post-new.php |
| 244 | * |
| 245 | * @return bool |
| 246 | */ |
| 247 | function jetpack_is_new_post_screen() { |
| 248 | global $current_screen; |
| 249 | |
| 250 | if ( |
| 251 | $current_screen instanceof \WP_Screen && |
| 252 | 'add' === $current_screen->action && |
| 253 | 'post' === $current_screen->post_type |
| 254 | ) { |
| 255 | return true; |
| 256 | } |
| 257 | |
| 258 | return false; |
| 259 | } |
| 260 | |
| 261 | /** |
| 262 | * Determines if the site might have a blog. |
| 263 | * |
| 264 | * @return bool |
| 265 | */ |
| 266 | function jetpack_is_potential_blogging_site() { |
| 267 | return jetpack_has_write_intent() || jetpack_has_posts_page() || jetpack_has_or_will_publish_posts(); |
| 268 | } |
| 269 |