Ticket #41946: remove_with_markers.patch

wp-admin/includes/misc.php

@@ -188 +188 @@
         return (bool) $bytes;
 }
 
+/**
+ * Removes a section between BEGIN and END markers in a file (.htaccess).
+ *
+ * Retains surrounding data. Creates file if none exists.
+ *
+ * @param string       $filename  Filename to alter.
+ * @param string       $marker    The marker to alter.
+ * @return bool True on write success, false on failure.
+ */
+function remove_with_markers( $filename, $marker ) {
+        if ( ! file_exists( $filename ) ) {
+                if ( ! is_writable( dirname( $filename ) ) ) {
+                        return false;
+                }
+        } elseif ( ! is_writeable( $filename ) ) {
+                return false;
+        }
+
+        $start_marker = "# BEGIN {$marker}";
+        $end_marker   = "# END {$marker}";
+
+        $fp = fopen( $filename, 'r+' );
+        if ( ! $fp ) {
+                return false;
+        }
+
+        // Attempt to get a lock. If the filesystem supports locking, this will block until the lock is acquired.
+        flock( $fp, LOCK_EX );
+
+        $lines = array();
+        while ( ! feof( $fp ) ) {
+                $lines[] = rtrim( fgets( $fp ), "\r\n" );
+        }
+
+        // Split out the existing file into the preceding lines, and those that appear after the marker.
+        $pre_lines    = $post_lines = array();
+        $found_marker = $found_end_marker = false;
+        foreach ( $lines as $line ) {
+                if ( ! $found_marker && false !== strpos( $line, $start_marker ) ) {
+                        $found_marker = true;
+                        continue;
+                } elseif ( ! $found_end_marker && false !== strpos( $line, $end_marker ) ) {
+                        $found_end_marker = true;
+                        continue;
+                }
+                if ( ! $found_marker ) {
+                        $pre_lines[] = $line;
+                } elseif ( $found_marker && $found_end_marker ) {
+                        $post_lines[] = $line;
+                }
+        }
+
+        // Check if both markers were found.
+        if ( ! $found_marker || ! $found_end_marker ) {
+                flock( $fp, LOCK_UN );
+                fclose( $fp );
+
+                return true;
+        }
+
+        // Generate the new file data.
+        $new_file_data = implode(
+                "\n",
+                array_merge(
+                        $pre_lines,
+                        $post_lines
+                )
+        );
+
+        // Write to the start of the file, and truncate it to that length.
+        fseek( $fp, 0 );
+        $bytes = fwrite( $fp, $new_file_data );
+        if ( $bytes ) {
+                ftruncate( $fp, ftell( $fp ) );
+        }
+        fflush( $fp );
+        flock( $fp, LOCK_UN );
+        fclose( $fp );
+
+        return (bool) $bytes;
+}
+
 /**
  * Updates the htaccess file with the current rules if it is writable.
  *