<!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>[35267] trunk/src/wp-admin/includes/misc.php: In `insert_with_markers()` restore the 4.3 behaviour of creating the file if it doesn't exist.</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="https://core.trac.wordpress.org/changeset/35267">35267</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/35267","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>2015-10-19 00:52:08 +0000 (Mon, 19 Oct 2015)</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'>In `insert_with_markers()` restore the 4.3 behaviour of creating the file if it doesn't exist.
This change also makes it bail early (without writing) if the markers content is the same as the existing, and uses `ftell()` rather than `$bytes` for the location to truncate the file to - based on the file pointer being at the end of the written stream.
Props willmot tigertech kevinatelement
See <a href="https://core.trac.wordpress.org/ticket/31767">#31767</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesmiscphp">trunk/src/wp-admin/includes/misc.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesmiscphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/misc.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/misc.php 2015-10-18 23:11:49 UTC (rev 35266)
+++ trunk/src/wp-admin/includes/misc.php 2015-10-19 00:52:08 UTC (rev 35267)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -96,18 +96,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $filename
- * @param string $marker
- * @param array $insertion
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $filename Filename to alter.
+ * @param string $marker The marker to alter.
+ * @param array|string $insertion The new content to insert.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool True on write success, false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function insert_with_markers( $filename, $marker, $insertion ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! is_writeable( $filename ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! file_exists( $filename ) ) {
+ if ( ! is_writable( dirname( $filename ) ) ) {
+ return false;
+ }
+ if ( ! touch( $filename ) ) {
+ return false;
+ }
+ } elseif ( ! is_writeable( $filename ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return false;
</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"> if ( ! is_array( $insertion ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $insertion = array( $insertion );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $insertion = explode( "\n", $insertion );
</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"> $start_marker = "# BEGIN {$marker}";
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -127,7 +134,7 @@
</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"> // Split out the existing file into the preceeding lines, and those that appear after the marker
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $pre_lines = $post_lines = array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $pre_lines = $post_lines = $existing_lines = array();
</ins><span class="cx" style="display: block; padding: 0 10px"> $found_marker = $found_end_marker = false;
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $lines as $line ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $found_marker && false !== strpos( $line, $start_marker ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -141,9 +148,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $pre_lines[] = $line;
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( $found_marker && $found_end_marker ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $post_lines[] = $line;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
+ $existing_lines[] = $line;
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Check to see if there was a change
+ if ( $existing_lines === $insertion ) {
+ flock( $fp, LOCK_UN );
+ fclose( $fp );
+
+ return true;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Generate the new file data
</span><span class="cx" style="display: block; padding: 0 10px"> $new_file_data = implode( "\n", array_merge(
</span><span class="cx" style="display: block; padding: 0 10px"> $pre_lines,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -157,9 +174,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> fseek( $fp, 0 );
</span><span class="cx" style="display: block; padding: 0 10px"> $bytes = fwrite( $fp, $new_file_data );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $bytes ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ftruncate( $fp, $bytes );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ftruncate( $fp, ftell( $fp ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ fflush( $fp );
</ins><span class="cx" style="display: block; padding: 0 10px"> flock( $fp, LOCK_UN );
</span><span class="cx" style="display: block; padding: 0 10px"> fclose( $fp );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>