<!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>[7717] sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/cli-commands.php: developer.wordpress.org: Add WP-CLI command for parsing WP source into the Code Reference.</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 { white-space: pre-line; 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/7717">7717</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/7717","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>2018-10-04 21:11:05 +0000 (Thu, 04 Oct 2018)</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: Add WP-CLI command for parsing WP source into the Code Reference.
Ex: `wp devhub parse /path/to/wp/code/to/parse 3606`</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperincclicommandsphp">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/cli-commands.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperincclicommandsphp"></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/inc/cli-commands.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-commands.php 2018-10-04 20:52:06 UTC (rev 7716)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/cli-commands.php 2018-10-04 21:11:05 UTC (rev 7717)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5,6 +5,116 @@
</span><span class="cx" style="display: block; padding: 0 10px"> class DevHub_Command extends WP_CLI_Command {
</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">+ * Parses WP code.
+ *
+ * The source code for the version of WordPress to be parsed needs to be
+ * obtained and unpackaged locally. You should not be code used in an
+ * active install.
+ *
+ * ## OPTIONS
+ *
+ * <path>
+ * : The path to a copy of WordPress to be parsed. Should not be code used in
+ * an active install.
+ *
+ * <user-id>
+ * : ID of user to attribute all parsed posts to.
+ *
+ * ## EXAMPLES
+ *
+ * # Parse WP 4.9.5 into DevHub.
+ * $ wp devhub /home/wporgdev/developer/wp495 3606
+ *
+ * @when after_wp_load
+ */
+ public function parse( $args, $assoc_args ) {
+ list( $path, $user_id ) = $args;
+
+ if ( ! is_numeric( $user_id ) ) {
+ WP_CLI::error( 'Invalid user_id provided.' );
+ } else {
+ $user_id = (int) $user_id;
+ }
+ WP_CLI::log( "Importing as user ID $user_id" );
+
+ $plugins = [
+ 'phpdoc-parser' => 'phpdoc-parser/plugin.php',
+ 'posts-to-posts' => 'posts-to-posts/posts-to-posts.php',
+ ];
+
+ // Verify path is a file or directory.
+ if ( ! file_exists( $path ) ) {
+ WP_CLI::error( 'Path for WordPress source to parse does not exist.' );
+ }
+
+ // Verify path is not a file.
+ if ( is_file( $path ) ) {
+ WP_CLI::error( 'Path provided for WordPress source to parse does not appear to be a directory.' );
+ }
+
+ // Verify path looks like WP.
+ if ( ! file_exists ( $path . '/wp-includes/version.php' ) ) {
+ WP_CLI::error( 'Path provided for WordPress source to parse does not contain WordPress files.' );
+ }
+
+ // Get WP version of files to be parsed.
+ $version_file = file_get_contents( $path . '/wp-includes/version.php' );
+ preg_match( '/\$wp_version = \'([^\']+)\'/', $version_file, $matches );
+ $version = $matches[1];
+
+ // Get WP version last parsed (if any) and confirm if reparsing that version.
+ $last_parsed_wp_ver = get_option( 'wp_parser_imported_wp_version' );
+ if ( $last_parsed_wp_ver && $last_parsed_wp_ver == $version ) {
+ $last_parsed_date = get_option( 'wp_parser_last_import' );
+ WP_CLI::confirm( "Looks like WP $version was already parsed on " . date_i18n( 'Y-m-d H:i', $last_parsed_date ) . ". Proceed anyway?" );
+ }
+
+ // Verify that the PHP-Parser plugin is available locally.
+ $all_plugins = get_plugins();
+ if ( ! in_array( $plugins['phpdoc-parser'], array_keys( $all_plugins ) ) ) {
+ // TODO: Attempt to install the plugin automatically.
+ WP_CLI::error( 'The PHP-Parser plugin (from https://github.com/WordPress/phpdoc-parser) is not installed locally in ' . WP_PLUGIN_DIR . '/.' );
+ }
+
+ // Confirm the parsing.
+ WP_CLI::confirm( "Are you sure you want to parse the source code for WP {$version} (and that you've run a backup of the existing data)?" );
+
+ // 1. Deactivate posts-to-posts plugin.
+ if ( is_plugin_active( $plugins['posts-to-posts'] ) ) {
+ WP_CLI::log( 'Deactivating posts-to-posts plugin...' );
+ WP_CLI::runcommand( 'plugin deactivate ' . $plugins['posts-to-posts'] );
+ } else {
+ WP_CLI::log( 'Warning: plugin posts-to-posts already deactivated.' );
+ }
+
+ // 2. Activate phpdoc-parser plugin.
+ if ( is_plugin_active( $plugins['phpdoc-parser'] ) ) {
+ WP_CLI::log( 'Warning: plugin phpdoc-parser already activated.' );
+ } else {
+ WP_CLI::log( 'Activating phpdoc-parser plugin...' );
+ WP_CLI::runcommand( 'plugin activate ' . $plugins['phpdoc-parser'] );
+ }
+
+ // 3. Run the parser.
+ WP_CLI::log( 'Running the parser (this will take awhile)...' );
+ WP_CLI::runcommand( "parser create {$path} --user={$user_id}" );
+
+ // 4. Deactivate phpdoc-parser plugin.
+ WP_CLI::log( 'Deactivating phpdoc-parser plugin...' );
+ WP_CLI::runcommand( 'plugin deactivate ' . $plugins['phpdoc-parser'] );
+
+ // 5. Activate posts-to-posts plugin.
+ WP_CLI::log( 'Activating posts-to-posts plugin...' );
+ WP_CLI::runcommand( 'plugin activate ' . $plugins['posts-to-posts'] );
+
+ // 6. Pre-cache source code.
+ WP_CLI::runcommand( 'devhub pre-cache-source' );
+
+ // Done.
+ WP_CLI::success( "Parsing of WP $version is complete." );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Pre-caches source for parsed post types that support showing source code.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * By default, source code shown for post types that have source code is read
</span></span></pre>
</div>
</div>
</body>
</html>