| | 1 | <?php |
| | 2 | |
| | 3 | namespace WPOrg_Hosting_Handbook; |
| | 4 | |
| | 5 | use WP_Error; |
| | 6 | use WP_Query; |
| | 7 | |
| | 8 | class Markdown_Import { |
| | 9 | |
| | 10 | private static $handbook_manifest = 'https://raw.githubusercontent.com/wordpress/hosting-handbook/master/bin/handbook-manifest.json'; |
| | 11 | private static $input_name = 'wporg-hosting-handbook-markdown-source'; |
| | 12 | private static $meta_key = 'wporg-hosting-handbook-markdown-source'; |
| | 13 | private static $nonce_name = 'wporg-hosting-handbook-markdown-source-nonce'; |
| | 14 | private static $submit_name = 'wporg-hosting-handbook-markdown-import'; |
| | 15 | private static $supported_post_types = array( 'handbook' ); |
| | 16 | private static $posts_per_page = 100; |
| | 17 | |
| | 18 | /** |
| | 19 | * Register our cron task if it doesn't already exist |
| | 20 | */ |
| | 21 | public static function action_init() { |
| | 22 | if ( ! wp_next_scheduled( 'wporg_hosting_handbook_manifest_import' ) ) { |
| | 23 | wp_schedule_event( time(), '15_minutes', 'wporg_hosting_handbook_manifest_import' ); |
| | 24 | } |
| | 25 | if ( ! wp_next_scheduled( 'wporg_hosting_handbook_markdown_import' ) ) { |
| | 26 | wp_schedule_event( time(), '15_minutes', 'wporg_hosting_handbook_markdown_import' ); |
| | 27 | } |
| | 28 | } |
| | 29 | |
| | 30 | public static function action_wporg_hosting_handbook_manifest_import() { |
| | 31 | $response = wp_remote_get( self::$handbook_manifest ); |
| | 32 | if ( is_wp_error( $response ) ) { |
| | 33 | return $response; |
| | 34 | } elseif ( 200 !== wp_remote_retrieve_response_code( $response ) ) { |
| | 35 | return new WP_Error( 'invalid-http-code', 'Markdown source returned non-200 http code.' ); |
| | 36 | } |
| | 37 | $manifest = json_decode( wp_remote_retrieve_body( $response ), true ); |
| | 38 | if ( ! $manifest ) { |
| | 39 | return new WP_Error( 'invalid-manifest', 'Manifest did not unfurl properly.' );; |
| | 40 | } |
| | 41 | // Fetch all handbook posts for comparison |
| | 42 | $q = new WP_Query( array( |
| | 43 | 'post_type' => self::$supported_post_types, |
| | 44 | 'post_status' => 'publish', |
| | 45 | 'posts_per_page' => self::$posts_per_page, |
| | 46 | ) ); |
| | 47 | $existing = $q->posts; |
| | 48 | $created = 0; |
| | 49 | foreach( $manifest as $doc ) { |
| | 50 | // Already exists |
| | 51 | if ( wp_filter_object_list( $existing, array( 'post_name' => $doc['slug'] ) ) ) { |
| | 52 | continue; |
| | 53 | } |
| | 54 | $post_parent = null; |
| | 55 | if ( ! empty( $doc['parent'] ) ) { |
| | 56 | // Find the parent in the existing set |
| | 57 | $parents = wp_filter_object_list( $existing, array( 'post_name' => $doc['parent'] ) ); |
| | 58 | if ( ! empty( $parents ) ) { |
| | 59 | $parent = array_shift( $parents ); |
| | 60 | } else { |
| | 61 | // Create the parent and add it to the stack |
| | 62 | if ( isset( $manifest[ $doc['parent'] ] ) ) { |
| | 63 | $parent_doc = $manifest[ $doc['parent'] ]; |
| | 64 | $parent = self::create_post_from_manifest_doc( $parent_doc ); |
| | 65 | if ( $parent ) { |
| | 66 | $created++; |
| | 67 | $existing[] = $parent; |
| | 68 | } else { |
| | 69 | continue; |
| | 70 | } |
| | 71 | } else { |
| | 72 | continue; |
| | 73 | } |
| | 74 | } |
| | 75 | $post_parent = $parent->ID; |
| | 76 | } |
| | 77 | $post = self::create_post_from_manifest_doc( $doc, $post_parent ); |
| | 78 | if ( $post ) { |
| | 79 | $created++; |
| | 80 | $existing[] = $post; |
| | 81 | } |
| | 82 | } |
| | 83 | if ( class_exists( 'WP_CLI' ) ) { |
| | 84 | \WP_CLI::success( "Successfully created {$created} handbook pages." ); |
| | 85 | } |
| | 86 | } |
| | 87 | |
| | 88 | /** |
| | 89 | * Create a new handbook page from the manifest document |
| | 90 | */ |
| | 91 | private static function create_post_from_manifest_doc( $doc, $post_parent = null ) { |
| | 92 | $post_data = array( |
| | 93 | 'post_type' => 'handbook', |
| | 94 | 'post_status' => 'publish', |
| | 95 | 'post_parent' => $post_parent, |
| | 96 | 'post_title' => sanitize_text_field( wp_slash( $doc['title'] ) ), |
| | 97 | 'post_name' => sanitize_title_with_dashes( $doc['slug'] ), |
| | 98 | ); |
| | 99 | $post_id = wp_insert_post( $post_data ); |
| | 100 | if ( ! $post_id ) { |
| | 101 | return false; |
| | 102 | } |
| | 103 | if ( class_exists( 'WP_CLI' ) ) { |
| | 104 | \WP_CLI::log( "Created post {$post_id} for {$doc['title']}." ); |
| | 105 | } |
| | 106 | update_post_meta( $post_id, self::$meta_key, esc_url_raw( $doc['markdown_source'] ) ); |
| | 107 | return get_post( $post_id ); |
| | 108 | } |
| | 109 | |
| | 110 | public static function action_wporg_hosting_handbook_markdown_import() { |
| | 111 | $q = new WP_Query( array( |
| | 112 | 'post_type' => self::$supported_post_types, |
| | 113 | 'post_status' => 'publish', |
| | 114 | 'fields' => 'ids', |
| | 115 | 'posts_per_page' => self::$posts_per_page, |
| | 116 | ) ); |
| | 117 | $ids = $q->posts; |
| | 118 | $success = 0; |
| | 119 | foreach( $ids as $id ) { |
| | 120 | $ret = self::update_post_from_markdown_source( $id ); |
| | 121 | if ( class_exists( 'WP_CLI' ) ) { |
| | 122 | if ( is_wp_error( $ret ) ) { |
| | 123 | \WP_CLI::warning( $ret->get_error_message() ); |
| | 124 | } else { |
| | 125 | \WP_CLI::log( "Updated {$id} from markdown source" ); |
| | 126 | $success++; |
| | 127 | } |
| | 128 | } |
| | 129 | } |
| | 130 | if ( class_exists( 'WP_CLI' ) ) { |
| | 131 | $total = count( $ids ); |
| | 132 | \WP_CLI::success( "Successfully updated {$success} of {$total} handbook pages." ); |
| | 133 | } |
| | 134 | } |
| | 135 | |
| | 136 | /** |
| | 137 | * Handle a request to import from the markdown source |
| | 138 | */ |
| | 139 | public static function action_load_post_php() { |
| | 140 | if ( ! isset( $_GET[ self::$submit_name ] ) |
| | 141 | || ! isset( $_GET[ self::$nonce_name ] ) |
| | 142 | || ! isset( $_GET['post'] ) ) { |
| | 143 | return; |
| | 144 | } |
| | 145 | $post_id = (int) $_GET['post']; |
| | 146 | if ( ! current_user_can( 'edit_post', $post_id ) |
| | 147 | || ! wp_verify_nonce( $_GET[ self::$nonce_name ], self::$input_name ) |
| | 148 | || ! in_array( get_post_type( $post_id ), self::$supported_post_types, true ) ) { |
| | 149 | return; |
| | 150 | } |
| | 151 | |
| | 152 | $response = self::update_post_from_markdown_source( $post_id ); |
| | 153 | if ( is_wp_error( $response ) ) { |
| | 154 | wp_die( $response->get_error_message() ); |
| | 155 | } |
| | 156 | |
| | 157 | wp_safe_redirect( get_edit_post_link( $post_id, 'raw' ) ); |
| | 158 | exit; |
| | 159 | } |
| | 160 | |
| | 161 | /** |
| | 162 | * Add an input field for specifying Markdown source |
| | 163 | */ |
| | 164 | public static function action_edit_form_after_title( $post ) { |
| | 165 | if ( ! in_array( $post->post_type, self::$supported_post_types, true ) ) { |
| | 166 | return; |
| | 167 | } |
| | 168 | $markdown_source = get_post_meta( $post->ID, self::$meta_key, true ); |
| | 169 | ?> |
| | 170 | <label>Markdown source: <input |
| | 171 | type="text" |
| | 172 | name="<?php echo esc_attr( self::$input_name ); ?>" |
| | 173 | value="<?php echo esc_attr( $markdown_source ); ?>" |
| | 174 | placeholder="Enter a URL representing a markdown file to import" |
| | 175 | size="50" /> |
| | 176 | </label> <?php |
| | 177 | if ( $markdown_source ) : |
| | 178 | $update_link = add_query_arg( array( |
| | 179 | self::$submit_name => 'import', |
| | 180 | self::$nonce_name => wp_create_nonce( self::$input_name ), |
| | 181 | ), get_edit_post_link( $post->ID, 'raw' ) ); |
| | 182 | ?> |
| | 183 | <a class="button button-small button-primary" href="<?php echo esc_url( $update_link ); ?>">Import</a> |
| | 184 | <?php endif; ?> |
| | 185 | <?php wp_nonce_field( self::$input_name, self::$nonce_name ); ?> |
| | 186 | <?php |
| | 187 | } |
| | 188 | |
| | 189 | /** |
| | 190 | * Save the Markdown source input field |
| | 191 | */ |
| | 192 | public static function action_save_post( $post_id ) { |
| | 193 | |
| | 194 | if ( ! isset( $_POST[ self::$input_name ] ) |
| | 195 | || ! isset( $_POST[ self::$nonce_name ] ) |
| | 196 | || ! in_array( get_post_type( $post_id ), self::$supported_post_types, true ) ) { |
| | 197 | return; |
| | 198 | } |
| | 199 | |
| | 200 | if ( ! wp_verify_nonce( $_POST[ self::$nonce_name ], self::$input_name ) ) { |
| | 201 | return; |
| | 202 | } |
| | 203 | |
| | 204 | $markdown_source = ''; |
| | 205 | if ( ! empty( $_POST[ self::$input_name ] ) ) { |
| | 206 | $markdown_source = esc_url_raw( $_POST[ self::$input_name ] ); |
| | 207 | } |
| | 208 | update_post_meta( $post_id, self::$meta_key, $markdown_source ); |
| | 209 | } |
| | 210 | |
| | 211 | /** |
| | 212 | * Filter cron schedules to add a 15 minute schedule |
| | 213 | */ |
| | 214 | public static function filter_cron_schedules( $schedules ) { |
| | 215 | $schedules['15_minutes'] = array( |
| | 216 | 'interval' => 15 * MINUTE_IN_SECONDS, |
| | 217 | 'display' => '15 minutes' |
| | 218 | ); |
| | 219 | return $schedules; |
| | 220 | } |
| | 221 | |
| | 222 | /** |
| | 223 | * Update a post from its Markdown source |
| | 224 | */ |
| | 225 | private static function update_post_from_markdown_source( $post_id ) { |
| | 226 | $markdown_source = self::get_markdown_source( $post_id ); |
| | 227 | if ( is_wp_error( $markdown_source ) ) { |
| | 228 | return $markdown_source; |
| | 229 | } |
| | 230 | if ( ! function_exists( 'jetpack_require_lib' ) ) { |
| | 231 | return new WP_Error( 'missing-jetpack-require-lib', 'jetpack_require_lib() is missing on system.' ); |
| | 232 | } |
| | 233 | |
| | 234 | // Transform GitHub repo HTML pages into their raw equivalents |
| | 235 | $markdown_source = preg_replace( '#https?://github\.com/([^/]+/[^/]+)/blob/(.+)#', 'https://raw.githubusercontent.com/$1/$2', $markdown_source ); |
| | 236 | $markdown_source = add_query_arg( 'v', time(), $markdown_source ); |
| | 237 | $response = wp_remote_get( $markdown_source ); |
| | 238 | if ( is_wp_error( $response ) ) { |
| | 239 | return $response; |
| | 240 | } elseif ( 200 !== wp_remote_retrieve_response_code( $response ) ) { |
| | 241 | return new WP_Error( 'invalid-http-code', 'Markdown source returned non-200 http code.' ); |
| | 242 | } |
| | 243 | |
| | 244 | $markdown = wp_remote_retrieve_body( $response ); |
| | 245 | // Strip YAML doc from the header |
| | 246 | $markdown = preg_replace( '#^---(.+)---#Us', '', $markdown ); |
| | 247 | |
| | 248 | $title = null; |
| | 249 | if ( preg_match( '/^#\s(.+)/', $markdown, $matches ) ) { |
| | 250 | $title = $matches[1]; |
| | 251 | $markdown = preg_replace( '/^#\s(.+)/', '', $markdown ); |
| | 252 | } |
| | 253 | |
| | 254 | // Transform to HTML and save the post |
| | 255 | jetpack_require_lib( 'markdown' ); |
| | 256 | $parser = new \WPCom_GHF_Markdown_Parser; |
| | 257 | $html = $parser->transform( $markdown ); |
| | 258 | $post_data = array( |
| | 259 | 'ID' => $post_id, |
| | 260 | 'post_content' => wp_filter_post_kses( wp_slash( $html ) ), |
| | 261 | ); |
| | 262 | if ( ! is_null( $title ) ) { |
| | 263 | $post_data['post_title'] = sanitize_text_field( wp_slash( $title ) ); |
| | 264 | } |
| | 265 | wp_update_post( $post_data ); |
| | 266 | return true; |
| | 267 | } |
| | 268 | |
| | 269 | /** |
| | 270 | * Retrieve the markdown source URL for a given post. |
| | 271 | */ |
| | 272 | public static function get_markdown_source( $post_id ) { |
| | 273 | $markdown_source = get_post_meta( $post_id, self::$meta_key, true ); |
| | 274 | if ( ! $markdown_source ) { |
| | 275 | return new WP_Error( 'missing-markdown-source', 'Markdown source is missing for post.' ); |
| | 276 | } |
| | 277 | |
| | 278 | return $markdown_source; |
| | 279 | } |
| | 280 | } |