<!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>[10786] sites/trunk/wordpress.org/public_html/wp-content/plugins/theme-directory/class-wporg-themes-upload.php: Theme Directory: Update the uploader to use an `exec()` wrapper which triggers PHP Notices/Warnings on errors to help determine if there's anything failing in the shell commands component of uploads.</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/10786">10786</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/10786","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-03-05 02:44:35 +0000 (Fri, 05 Mar 2021)</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'>Theme Directory: Update the uploader to use an `exec()` wrapper which triggers PHP Notices/Warnings on errors to help determine if there's anything failing in the shell commands component of uploads.
Previously an error in one of these steps would not be seen until a developer were to get the problematic uploaded ZIP file and debug it interactively, this causes the warnings/errors to end up in the WordPress.org PHP Logging instead.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsthemedirectoryclasswporgthemesuploadphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/theme-directory/class-wporg-themes-upload.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsthemedirectoryclasswporgthemesuploadphp"></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/plugins/theme-directory/class-wporg-themes-upload.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/plugins/theme-directory/class-wporg-themes-upload.php 2021-03-05 01:18:20 UTC (rev 10785)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/theme-directory/class-wporg-themes-upload.php 2021-03-05 02:44:35 UTC (rev 10786)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -441,11 +441,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $tmp_dir = escapeshellarg( $this->tmp_dir );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Unzip it into the theme directory.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- exec( escapeshellcmd( "{$unzip} -DD {$zip_file} -d {$tmp_dir}/{$base_name}" ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->exec_with_notify( escapeshellcmd( "{$unzip} -DD {$zip_file} -d {$tmp_dir}/{$base_name}" ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Fix any permissions issues with the files. Sets 755 on directories, 644 on files
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- exec( escapeshellcmd( "chmod -R 755 {$tmp_dir}/{$base_name}" ) );
- exec( escapeshellcmd( "find {$tmp_dir}/{$base_name} -type f -print0" ) . ' | xargs -I% -0 chmod 644 %' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->exec_with_notify( escapeshellcmd( "chmod -R 755 {$tmp_dir}/{$base_name}" ) );
+ $this->exec_with_notify( escapeshellcmd( "find {$tmp_dir}/{$base_name} -type f -print0" ) . ' | xargs -I% -0 chmod 644 %' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -947,8 +947,11 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $new_version_dir = escapeshellarg( "{$this->tmp_svn_dir}/{$this->theme->display( 'Version' )}" );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Keeps a copy of the output of the commands for debugging.
+ $output = array();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Theme exists, attempt to do a copy from old version to new.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- exec( self::SVN . " co https://themes.svn.wordpress.org/{$this->theme_slug}/ {$this->tmp_svn_dir} --depth=empty 2>&1", $output, $return_var );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->exec_with_notify( self::SVN . " co https://themes.svn.wordpress.org/{$this->theme_slug}/ {$this->tmp_svn_dir} --depth=empty", $output, $return_var );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $return_var > 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $this->add_to_svn_via_svn_import();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -955,20 +958,20 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Try to copy the previous version over.
</span><span class="cx" style="display: block; padding: 0 10px"> $prev_version = escapeshellarg( "https://themes.svn.wordpress.org/{$this->theme_slug}/{$this->theme_post->max_version}" );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- exec( self::SVN . " cp $prev_version $new_version_dir 2>&1", $output, $return_var );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->exec_with_notify( self::SVN . " cp $prev_version $new_version_dir", $output, $return_var );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $return_var > 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $this->add_to_svn_via_svn_import();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Remove the files from the old version, so that we can track file removals.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- exec( self::RM . " -rf {$new_version_dir}/*" );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->exec_with_notify( self::RM . " -rf {$new_version_dir}/*", $output );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $theme_dir = escapeshellarg( $this->theme_dir );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- exec( self::CP . " -R {$theme_dir}/* {$new_version_dir}" );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->exec_with_notify( self::CP . " -R {$theme_dir}/* {$new_version_dir}", $output );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Process file additions and removals.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- exec( self::SVN . " st {$new_version_dir} | grep '^?' | cut -c 2- | xargs -I{} " . self::SVN . " add {}" );
- exec( self::SVN . " st {$new_version_dir} | grep '^!' | cut -c 2- | xargs -I{} " . self::SVN . " rm {}" );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->exec_with_notify( self::SVN . " st {$new_version_dir} | grep '^?' | cut -c 2- | xargs -I% " . self::SVN . " add %", $output );
+ $this->exec_with_notify( self::SVN . " st {$new_version_dir} | grep '^!' | cut -c 2- | xargs -I% " . self::SVN . " rm %", $output );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Commit it to SVN.
</span><span class="cx" style="display: block; padding: 0 10px"> $password = escapeshellarg( THEME_DROPBOX_PASSWORD );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -977,12 +980,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->theme->display( 'Name' ),
</span><span class="cx" style="display: block; padding: 0 10px"> $this->theme->display( 'Version' )
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- exec( self::SVN . " ci --non-interactive --username themedropbox --password {$password} -m {$message} {$new_version_dir} 2>&1", $output, $return_var );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /* DEBUGGING
+ dump the output of $output here and return false;
+ */
+
+ $last_line = $this->exec_with_notify( self::SVN . " ci --non-interactive --username themedropbox --password {$password} -m {$message} {$new_version_dir}", $output, $return_var );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $return_var > 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $this->add_to_svn_via_svn_import();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( preg_match( '/Committed revision (\d+)./i', implode( '', $output ), $m ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( preg_match( '/Committed revision (\d+)\./i', $last_line, $m ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->trac_changeset = $m[1];
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1001,9 +1009,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $svn = escapeshellarg( self::SVN );
</span><span class="cx" style="display: block; padding: 0 10px"> $password = escapeshellarg( THEME_DROPBOX_PASSWORD );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $result = exec( "{$svn} --non-interactive --username themedropbox --password {$password} --no-auto-props -m {$import_msg} import {$theme_path} {$svn_path} 2>&1" );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $last_line = $this->exec_with_notify( "{$svn} --non-interactive --username themedropbox --password {$password} --no-auto-props -m {$import_msg} import {$theme_path} {$svn_path}" );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( preg_match( '/Committed revision (\d+)./i', $result, $m ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( preg_match( '/Committed revision (\d+)\./i', $last_line, $m ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->trac_changeset = $m[1];
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1210,7 +1218,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $rm = escapeshellarg( self::RM );
</span><span class="cx" style="display: block; padding: 0 10px"> $files = escapeshellarg( $this->tmp_dir );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- exec( escapeshellcmd( "{$rm} -rf {$files}" ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->exec_with_notify( escapeshellcmd( "{$rm} -rf {$files}" ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1237,4 +1245,53 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected function sort_by_string_length( $a, $b ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return strlen( $b ) - strlen( $a );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Execute a shell process, same behaviour as `exec()` but with PHP Warnings/Notices generated on errors.
+ *
+ * @param string $command Command to execute. Escape it.
+ * @param array $output Array to append program output to. Passed by reference.
+ * @param int $return_var The commands return value. Passed by reference.
+ *
+ * @return false|string False on failure, last line of output on success, as per exec().
+ */
+ public function exec_with_notify( $command, &$output = null, &$return_var = null ) {
+ $proc = proc_open(
+ $command,
+ [
+ 1 => [ 'pipe', 'w' ], // STDOUT
+ 2 => [ 'pipe', 'w' ], // STDERR
+ ],
+ $pipes
+ );
+
+ $stdout = stream_get_contents( $pipes[1] );
+ $stderr = stream_get_contents( $pipes[2] );
+ fclose( $pipes[1] );
+ fclose( $pipes[2] );
+
+ $return_var = proc_close( $proc );
+
+ // Append to $output, as `exec()` does.
+ if ( ! is_array( $output ) ) {
+ $output = [];
+ }
+ if ( $stdout ) {
+ $output = array_merge( $output, explode( "\n", rtrim( $stdout, "\r\n" ) ) );
+ }
+
+ if ( $return_var > 0 ) {
+ trigger_error( "Command failed, `{$command}` return value: {$return_var} STDOUT: ```{$stdout}``` STDERR: ```{$stderr}```", E_USER_WARNING );
+ } elseif ( $stderr ) {
+ trigger_error( "Command produced errors, `{$command}` return value: {$return_var} STDOUT: ```{$stdout}``` STDERR: ```{$stderr}```", E_USER_NOTICE );
+ }
+
+ // Execution failed.
+ if ( $return_var > 0 ) {
+ return false;
+ }
+
+ // Successful, return the last output line.
+ return $stdout ? end( $output ) : '';
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>