<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[5469] sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer: developer.wordpress.org: Register `command` post type and cron jobs for importing command documentation.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/5469">5469</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/5469","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>coffee2code</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-05-03 17:54:08 +0000 (Wed, 03 May 2017)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>developer.wordpress.org: Register `command` post type and cron jobs for importing command documentation.
For wp-cli command documentation.
Props danielbachhuber.
Fixes <a href="http://meta.trac.wordpress.org/ticket/2465">#2465</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperfunctionsphp">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/functions.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperinccliphp">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/cli.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/functions.php 2017-05-03 17:43:24 UTC (rev 5468)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/functions.php 2017-05-03 17:54:08 UTC (rev 5469)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,6 +56,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require __DIR__ . '/inc/user-content-voting.php';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * CLI commands custom post type and importer.
+ */
+require __DIR__ . '/inc/cli.php';
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Explanations for functions. hooks, classes, and methods.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> require( __DIR__ . '/inc/explanations.php' );
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperinccliphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/cli.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/cli.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/cli.php 2017-05-03 17:54:08 UTC (rev 5469)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,242 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+class DevHub_CLI {
+
+ private static $commands_manifest = 'https://raw.githubusercontent.com/wp-cli/handbook/master/bin/commands-manifest.json';
+ private static $meta_key = 'wporg_cli_markdown_source';
+ private static $supported_post_types = array( 'command' );
+ private static $posts_per_page = 350;
+
+ public static function init() {
+ add_action( 'init', array( __CLASS__, 'action_init_register_cron_jobs' ) );
+ add_action( 'init', array( __CLASS__, 'action_init_register_post_types' ) );
+ add_action( 'devhub_cli_manifest_import', array( __CLASS__, 'action_devhub_cli_manifest_import' ) );
+ add_action( 'devhub_cli_markdown_import', array( __CLASS__, 'action_devhub_cli_markdown_import' ) );
+ }
+
+ public static function action_init_register_cron_jobs() {
+ if ( ! wp_next_scheduled( 'devhub_cli_manifest_import' ) ) {
+ wp_schedule_event( time(), 'twicedaily', 'devhub_cli_manifest_import' );
+ }
+ if ( ! wp_next_scheduled( 'devhub_cli_markdown_import' ) ) {
+ wp_schedule_event( time(), 'twicedaily', 'devhub_cli_markdown_import' );
+ }
+ }
+
+ public static function action_init_register_post_types() {
+ $supports = array(
+ 'comments',
+ 'custom-fields',
+ 'editor',
+ 'excerpt',
+ 'revisions',
+ 'title',
+ );
+ register_post_type( 'command', array(
+ 'has_archive' => 'cli/commands',
+ 'label' => __( 'Commands', 'wporg' ),
+ 'labels' => array(
+ 'name' => __( 'Commands', 'wporg' ),
+ 'singular_name' => __( 'Command', 'wporg' ),
+ 'all_items' => __( 'Commands', 'wporg' ),
+ 'new_item' => __( 'New Command', 'wporg' ),
+ 'add_new' => __( 'Add New', 'wporg' ),
+ 'add_new_item' => __( 'Add New Command', 'wporg' ),
+ 'edit_item' => __( 'Edit Command', 'wporg' ),
+ 'view_item' => __( 'View Command', 'wporg' ),
+ 'search_items' => __( 'Search Commands', 'wporg' ),
+ 'not_found' => __( 'No Commands found', 'wporg' ),
+ 'not_found_in_trash' => __( 'No Commands found in trash', 'wporg' ),
+ 'parent_item_colon' => __( 'Parent Command', 'wporg' ),
+ 'menu_name' => __( 'Commands', 'wporg' ),
+ ),
+ 'public' => true,
+ 'hierarchical'=> true,
+ 'rewrite' => array(
+ 'feeds' => false,
+ 'slug' => 'cli/commands',
+ 'with_front' => false,
+ ),
+ 'supports' => $supports,
+ ) );
+ }
+
+ public static function action_devhub_cli_manifest_import() {
+ $response = wp_remote_get( self::$commands_manifest );
+ if ( is_wp_error( $response ) ) {
+ return $response;
+ } elseif ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
+ return new WP_Error( 'invalid-http-code', 'Markdown source returned non-200 http code.' );
+ }
+ $manifest = json_decode( wp_remote_retrieve_body( $response ), true );
+ if ( ! $manifest ) {
+ return new WP_Error( 'invalid-manifest', 'Manifest did not unfurl properly.' );;
+ }
+ // Fetch all handbook posts for comparison
+ $q = new WP_Query( array(
+ 'post_type' => self::$supported_post_types,
+ 'post_status' => 'publish',
+ 'posts_per_page' => self::$posts_per_page,
+ ) );
+ $existing = array();
+ foreach( $q->posts as $post ) {
+ $cmd_path = rtrim( str_replace( home_url( 'cli/commands/' ), '', get_permalink( $post->ID ) ), '/' );
+ $existing[ $cmd_path ] = array(
+ 'post_id' => $post->ID,
+ 'cmd_path' => $cmd_path,
+ );
+ }
+ $created = 0;
+ foreach( $manifest as $doc ) {
+ // Already exists
+ if ( wp_filter_object_list( $existing, array( 'cmd_path' => $doc['cmd_path'] ) ) ) {
+ continue;
+ }
+ if ( self::process_manifest_doc( $doc, $existing, $manifest ) ) {
+ $created++;
+ }
+ }
+ if ( class_exists( 'WP_CLI' ) ) {
+ \WP_CLI::success( "Successfully created {$created} handbook pages." );
+ }
+ }
+
+ private static function process_manifest_doc( $doc, &$existing, $manifest ) {
+ $post_parent = null;
+ if ( ! empty( $doc['parent'] ) ) {
+ // Find the parent in the existing set
+ $parents = wp_filter_object_list( $existing, array( 'cmd_path' => $doc['parent'] ) );
+ if ( empty( $parents ) ) {
+ if ( ! self::process_manifest_doc( $manifest[ $doc['parent'] ], $existing, $manifest ) ) {
+ return;
+ }
+ $parents = wp_filter_object_list( $existing, array( 'cmd_path' => $doc['parent'] ) );
+ }
+ if ( ! empty( $parents ) ) {
+ $parent = array_shift( $parents );
+ $post_parent = $parent['post_id'];
+ }
+ }
+ $post = self::create_post_from_manifest_doc( $doc, $post_parent );
+ if ( $post ) {
+ $cmd_path = rtrim( str_replace( home_url( 'cli/commands/' ), '', get_permalink( $post->ID ) ), '/' );
+ $existing[ $cmd_path ] = array(
+ 'post_id' => $post->ID,
+ 'cmd_path' => $cmd_path,
+ );
+ return true;
+ }
+ return false;
+ }
+
+ public static function action_devhub_cli_markdown_import() {
+ $q = new WP_Query( array(
+ 'post_type' => self::$supported_post_types,
+ 'post_status' => 'publish',
+ 'fields' => 'ids',
+ 'posts_per_page' => self::$posts_per_page,
+ ) );
+ $ids = $q->posts;
+ $success = 0;
+ foreach( $ids as $id ) {
+ $ret = self::update_post_from_markdown_source( $id );
+ if ( class_exists( 'WP_CLI' ) ) {
+ if ( is_wp_error( $ret ) ) {
+ \WP_CLI::warning( $ret->get_error_message() );
+ } else {
+ \WP_CLI::log( "Updated {$id} from markdown source" );
+ $success++;
+ }
+ }
+ }
+ if ( class_exists( 'WP_CLI' ) ) {
+ $total = count( $ids );
+ \WP_CLI::success( "Successfully updated {$success} of {$total} CLI command pages." );
+ }
+ }
+
+ /**
+ * Create a new handbook page from the manifest document
+ */
+ private static function create_post_from_manifest_doc( $doc, $post_parent = null ) {
+ $post_data = array(
+ 'post_type' => 'command',
+ 'post_status' => 'publish',
+ 'post_parent' => $post_parent,
+ 'post_title' => sanitize_text_field( wp_slash( $doc['title'] ) ),
+ 'post_name' => sanitize_title_with_dashes( $doc['slug'] ),
+ );
+ $post_id = wp_insert_post( $post_data );
+ if ( ! $post_id ) {
+ return false;
+ }
+ if ( class_exists( 'WP_CLI' ) ) {
+ \WP_CLI::log( "Created post {$post_id} for {$doc['title']}." );
+ }
+ update_post_meta( $post_id, self::$meta_key, esc_url_raw( $doc['markdown_source'] ) );
+ return get_post( $post_id );
+ }
+
+ /**
+ * Update a post from its Markdown source
+ */
+ private static function update_post_from_markdown_source( $post_id ) {
+ $markdown_source = self::get_markdown_source( $post_id );
+ if ( is_wp_error( $markdown_source ) ) {
+ return $markdown_source;
+ }
+ if ( ! function_exists( 'jetpack_require_lib' ) ) {
+ return new WP_Error( 'missing-jetpack-require-lib', 'jetpack_require_lib() is missing on system.' );
+ }
+
+ // Transform GitHub repo HTML pages into their raw equivalents
+ $markdown_source = preg_replace( '#https?://github\.com/([^/]+/[^/]+)/blob/(.+)#', 'https://raw.githubusercontent.com/$1/$2', $markdown_source );
+ $markdown_source = add_query_arg( 'v', time(), $markdown_source );
+ $response = wp_remote_get( $markdown_source );
+ if ( is_wp_error( $response ) ) {
+ return $response;
+ } elseif ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
+ return new WP_Error( 'invalid-http-code', 'Markdown source returned non-200 http code.' );
+ }
+
+ $markdown = wp_remote_retrieve_body( $response );
+ // Strip YAML doc from the header
+ $markdown = preg_replace( '#^---(.+)---#Us', '', $markdown );
+
+ $title = null;
+ if ( preg_match( '/^#\s(.+)/', $markdown, $matches ) ) {
+ $title = $matches[1];
+ $markdown = preg_replace( '/^#\swp\s(.+)/', '', $markdown );
+ }
+
+ // Transform to HTML and save the post
+ jetpack_require_lib( 'markdown' );
+ $parser = new \WPCom_GHF_Markdown_Parser;
+ $html = $parser->transform( $markdown );
+ $post_data = array(
+ 'ID' => $post_id,
+ 'post_content' => wp_filter_post_kses( wp_slash( $html ) ),
+ );
+ if ( ! is_null( $title ) ) {
+ $post_data['post_title'] = sanitize_text_field( wp_slash( $title ) );
+ }
+ wp_update_post( $post_data );
+ return true;
+ }
+
+ /**
+ * Retrieve the markdown source URL for a given post.
+ */
+ public static function get_markdown_source( $post_id ) {
+ $markdown_source = get_post_meta( $post_id, self::$meta_key, true );
+ if ( ! $markdown_source ) {
+ return new WP_Error( 'missing-markdown-source', 'Markdown source is missing for post.' );
+ }
+
+ return $markdown_source;
+ }
+
+}
+
+DevHub_CLI::init();
+
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/cli.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>