<!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>[50775] trunk/src/wp-admin/setup-config.php: Upgrade/Install: Prevent possible type errors during installation.</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="https://core.trac.wordpress.org/changeset/50775">50775</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/50775","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-04-21 01:31:45 +0000 (Wed, 21 Apr 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'>Upgrade/Install: Prevent possible type errors during installation.

Prevent a `TypeError` from occurring during installation if `wp-config.php` is not writable. In PHP 8.0 this can cause a fatal error, in earlier versions of PHP a warning would be thrown.

Account for a change in type returned by `fopen()` coming in a future version of PHP. Minor coding standards fixes in the `/wp-admin/setup-config.php` file.

Props xknown, hellofromTonya, jrf, peterwilsoncc.
See <a href="https://core.trac.wordpress.org/ticket/51423">#51423</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminsetupconfigphp">trunk/src/wp-admin/setup-config.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminsetupconfigphp"></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/setup-config.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/setup-config.php       2021-04-20 20:00:16 UTC (rev 50774)
+++ trunk/src/wp-admin/setup-config.php 2021-04-21 01:31:45 UTC (rev 50775)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -426,33 +426,63 @@
</span><span class="cx" style="display: block; padding: 0 10px"> })();
</span><span class="cx" style="display: block; padding: 0 10px"> </script>
</span><span class="cx" style="display: block; padding: 0 10px">                        <?php
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        else :
-               /*
-                * If this file doesn't exist, then we are using the wp-config-sample.php
-                * file one level up, which is for the develop repo.
-                */
-               if ( file_exists( ABSPATH . 'wp-config-sample.php' ) ) {
-                       $path_to_wp_config = ABSPATH . 'wp-config.php';
-               } else {
-                       $path_to_wp_config = dirname( ABSPATH ) . '/wp-config.php';
-               }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         else :
+                       /*
+                        * If this file doesn't exist, then we are using the wp-config-sample.php
+                        * file one level up, which is for the develop repo.
+                        */
+                       if ( file_exists( ABSPATH . 'wp-config-sample.php' ) ) {
+                               $path_to_wp_config = ABSPATH . 'wp-config.php';
+                       } else {
+                               $path_to_wp_config = dirname( ABSPATH ) . '/wp-config.php';
+                       }
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                $handle = fopen( $path_to_wp_config, 'w' );
-               foreach ( $config_file as $line ) {
-                       fwrite( $handle, $line );
-               }
-               fclose( $handle );
-               chmod( $path_to_wp_config, 0666 );
-               setup_config_display_header();
-               ?>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                 $error_message = '';
+                       $handle        = fopen( $path_to_wp_config, 'w' );
+                       /*
+                        * Why check for the absence of false instead of checking for resource with is_resource()?
+                        * To future-proof the check for when fopen returns object instead of resource, i.e. a known
+                        * change coming in PHP.
+                        */
+                       if ( false !== $handle ) {
+                               foreach ( $config_file as $line ) {
+                                       fwrite( $handle, $line );
+                               }
+                               fclose( $handle );
+                       } else {
+                               $wp_config_perms = fileperms( $path_to_wp_config );
+                               if ( ! empty( $wp_config_perms ) && ! is_writable( $path_to_wp_config ) ) {
+                                       $error_message   = sprintf(
+                                               /* translators: 1 wp-config.php, 2: Documentation URL. */
+                                               __( 'You need to make the file %1$s writable before you can save your changes. See <a href="%2$s">Changing File Permissions</a> for more information.' ),
+                                               '<code>wp-config.php</code>',
+                                               __( 'https://wordpress.org/support/article/changing-file-permissions/' )
+                                       );
+                               } else {
+                                       $error_message = sprintf(
+                                               /* translators: %s: wp-config.php */
+                                               __( 'Unable to write to %s file.' ),
+                                               '<code>wp-config.php</code>'
+                                       );
+                               }
+                       }
+
+                       chmod( $path_to_wp_config, 0666 );
+                       setup_config_display_header();
+
+                       if ( false !== $handle ) :
+                               ?>
</ins><span class="cx" style="display: block; padding: 0 10px"> <h1 class="screen-reader-text"><?php _e( 'Successful database connection' ); ?></h1>
</span><span class="cx" style="display: block; padding: 0 10px"> <p><?php _e( 'All right, sparky! You&#8217;ve made it through this part of the installation. WordPress can now communicate with your database. If you are ready, time now to&hellip;' ); ?></p>
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px"> <p class="step"><a href="<?php echo $install; ?>" class="button button-large"><?php _e( 'Run the installation' ); ?></a></p>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                <?php
-       endif;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                         <?php
+                       else :
+                               printf( '<p>%s</p>', $error_message );
+                       endif;
+               endif;
</ins><span class="cx" style="display: block; padding: 0 10px">                 break;
</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">+} // End of the steps switch.
</ins><span class="cx" style="display: block; padding: 0 10px"> ?>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php wp_print_scripts( 'language-chooser' ); ?>
</span><span class="cx" style="display: block; padding: 0 10px"> </body>
</span></span></pre>
</div>
</div>

</body>
</html>