* LiteSpeed File Operator Library Class
* Append/Replace content to a file
defined('WPINC') || exit();
const MARKER = 'LiteSpeed Operator';
* Detect if an URL is 404
public static function is_404( $url ) {
$response = wp_safe_remote_get($url);
$code = wp_remote_retrieve_response_code($response);
public static function rrmdir( $dir ) {
$files = array_diff(scandir($dir), array( '.', '..' ));
foreach ($files as $file) {
is_dir("$dir/$file") ? self::rrmdir("$dir/$file") : unlink("$dir/$file");
public static function count_lines( $filename ) {
if (!file_exists($filename)) {
$file = new \SplFileObject($filename);
$file->seek(PHP_INT_MAX);
* @param string $filename
public static function read( $filename, $start_line = null, $lines = null ) {
if (!file_exists($filename)) {
if (!is_readable($filename)) {
if ($start_line !== null) {
$file = new \SplFileObject($filename);
$file->seek($start_line);
$res[] = rtrim($file->current(), "\n");
for ($i = 0; $i < $lines; $i++) {
$res[] = rtrim($file->current(), "\n");
$content = file_get_contents($filename);
$content = self::remove_zero_space($content);
* @param string $filename
* @param boolean $silence Used to avoid WP's functions are used
public static function append( $filename, $data, $mkdir = false, $silence = true ) {
return self::save($filename, $data, $mkdir, true, $silence);
* @param string $filename
* @param boolean $append If the content needs to be appended
* @param boolean $silence Used to avoid WP's functions are used
public static function save( $filename, $data, $mkdir = false, $append = false, $silence = true ) {
if (is_null($filename)) {
return $silence ? false : __('Filename is empty!', 'litespeed-cache');
$folder = dirname($filename);
// mkdir if folder does not exist
if (!file_exists($folder)) {
return $silence ? false : sprintf(__('Folder does not exist: %s', 'litespeed-cache'), $folder);
set_error_handler('litespeed_exception_handler');
mkdir($folder, 0755, true);
// Create robots.txt file to forbid search engine indexes
if (!file_exists(LITESPEED_STATIC_DIR . '/robots.txt')) {
file_put_contents(LITESPEED_STATIC_DIR . '/robots.txt', "User-agent: *\nDisallow: /\n");
} catch (\ErrorException $ex) {
return $silence ? false : sprintf(__('Can not create folder: %1$s. Error: %2$s', 'litespeed-cache'), $folder, $ex->getMessage());
if (!file_exists($filename)) {
if (!is_writable($folder)) {
return $silence ? false : sprintf(__('Folder is not writable: %s.', 'litespeed-cache'), $folder);
set_error_handler('litespeed_exception_handler');
} catch (\ErrorException $ex) {
return $silence ? false : sprintf(__('File %s is not writable.', 'litespeed-cache'), $filename);
} elseif (!is_writable($filename)) {
return $silence ? false : sprintf(__('File %s is not writable.', 'litespeed-cache'), $filename);
$data = self::remove_zero_space($data);
$ret = file_put_contents($filename, $data, $append ? FILE_APPEND : LOCK_EX);
return $silence ? false : sprintf(__('Failed to write to %s.', 'litespeed-cache'), $filename);
* Remove Unicode zero-width space <200b><200c>
* @since 2.9 changed to public
public static function remove_zero_space( $content ) {
if (is_array($content)) {
$content = array_map(__CLASS__ . '::remove_zero_space', $content);
// Remove UTF-8 BOM if present
if (substr($content, 0, 3) === "\xEF\xBB\xBF") {
$content = substr($content, 3);
$content = str_replace("\xe2\x80\x8b", '', $content);
$content = str_replace("\xe2\x80\x8c", '', $content);
$content = str_replace("\xe2\x80\x8d", '', $content);
* Appends an array of strings into a file (.htaccess ), placing it between
* Replaces existing marked info. Retains surrounding
* data. Creates file if none exists.
* @param string $filename Filename to alter.
* @param string $marker The marker to alter.
* @param array|string|false $insertion The new content to insert.
* @param bool $prepend Prepend insertion if not exist.
* @return bool True on write success, false on failure.
public static function insert_with_markers( $filename, $insertion = false, $marker = false, $prepend = false ) {
return self::_insert_with_markers($filename, $marker, $insertion, $prepend); // todo: capture exceptions
* Return wrapped block data with marker
* @param string $insertion
* @return string The block data
public static function wrap_marker_data( $insertion, $marker = false ) {
$start_marker = "# BEGIN {$marker}";
$end_marker = "# END {$marker}";
$new_data = implode("\n", array_merge(array( $start_marker ), $insertion, array( $end_marker )));
* Touch block data from file, return with marker
* @param string $filename
* @return string The current block data
public static function touch_marker_data( $filename, $marker = false ) {
$result = self::_extract_from_markers($filename, $marker);
$start_marker = "# BEGIN {$marker}";
$end_marker = "# END {$marker}";
$new_data = implode("\n", array_merge(array( $start_marker ), $result, array( $end_marker )));
* Extracts strings from between the BEGIN and END markers in the .htaccess file.
* @param string $filename
* @return array An array of strings from a file (.htaccess ) from between BEGIN and END markers.
public static function extract_from_markers( $filename, $marker = false ) {
return self::_extract_from_markers($filename, $marker);
* Extracts strings from between the BEGIN and END markers in the .htaccess file.
* @param string $filename
* @return array An array of strings from a file (.htaccess ) from between BEGIN and END markers.
private static function _extract_from_markers( $filename, $marker ) {
if (!file_exists($filename)) {
if ($markerdata = explode("\n", implode('', file($filename)))) {
foreach ($markerdata as $markerline) {
if (strpos($markerline, '# END ' . $marker) !== false) {
if (strpos($markerline, '# BEGIN ' . $marker) !== false) {
return array_map('trim', $result);
* Inserts an array of strings into a file (.htaccess ), placing it between BEGIN and END markers.
* Replaces existing marked info. Retains surrounding data. Creates file if none exists.
* NOTE: will throw error if failed
* @since 3.0 Throw errors if failed
private static function _insert_with_markers( $filename, $marker, $insertion, $prepend = false ) {
if (!file_exists($filename)) {
if (!is_writable(dirname($filename))) {
Error::t('W', dirname($filename));
set_error_handler('litespeed_exception_handler');
} catch (\ErrorException $ex) {
Error::t('W', $filename);
} elseif (!is_writable($filename)) {
Error::t('W', $filename);
if (!is_array($insertion)) {
$insertion = explode("\n", $insertion);
$start_marker = "# BEGIN {$marker}";
$end_marker = "# END {$marker}";
$fp = fopen($filename, 'r+');
Error::t('W', $filename);
// Attempt to get a lock. If the filesystem supports locking, this will block until the lock is acquired.
$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 = $existing_lines = array();
$found_marker = $found_end_marker = false;
foreach ($lines as $line) {
if (!$found_marker && false !== strpos($line, $start_marker)) {
} elseif (!$found_end_marker && false !== strpos($line, $end_marker)) {
$found_end_marker = true;
} elseif ($found_marker && $found_end_marker) {
$existing_lines[] = $line;
// Check to see if there was a change
if ($existing_lines === $insertion) {
// Check if need to prepend data if not exist
if ($prepend && !$post_lines) {
// Generate the new file data
$new_file_data = implode("\n", array_merge(array( $start_marker ), $insertion, array( $end_marker ), $pre_lines));
// Generate the new file data
$new_file_data = implode("\n", array_merge($pre_lines, array( $start_marker ), $insertion, array( $end_marker ), $post_lines));
// Write to the start of the file, and truncate it to that length
$bytes = fwrite($fp, $new_file_data);
ftruncate($fp, ftell($fp));
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
