Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Helpers;

[2] Fix | Delete

[3] Fix | Delete

use WP_Filesystem_Base; // phpcs:ignore WPForms.PHP.UseStatement.UnusedUseStatement

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* Class File.

[7] Fix | Delete

[8] Fix | Delete

* @since 1.6.5

[9] Fix | Delete

[10] Fix | Delete

class File {

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Remove UTF-8 BOM signature if it presents.

[14] Fix | Delete

[15] Fix | Delete

* @since 1.6.5

[16] Fix | Delete

[17] Fix | Delete

* @param string $str String to process.

[18] Fix | Delete

[19] Fix | Delete

* @return string

[20] Fix | Delete

* @noinspection SpellCheckingInspection

[21] Fix | Delete

[22] Fix | Delete

public static function remove_utf8_bom( $str ): string {

[23] Fix | Delete

[24] Fix | Delete

if ( strpos( bin2hex( $str ), 'efbbbf' ) === 0 ) {

[25] Fix | Delete

$str = substr( $str, 3 );

[26] Fix | Delete

}

[27] Fix | Delete

[28] Fix | Delete

return $str;

[29] Fix | Delete

}

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Get current filesystem.

[33] Fix | Delete

[34] Fix | Delete

* @since 1.8.6

[35] Fix | Delete

[36] Fix | Delete

* @return WP_Filesystem_Base|null

[37] Fix | Delete

[38] Fix | Delete

public static function get_filesystem() {

[39] Fix | Delete

[40] Fix | Delete

global $wp_filesystem;

[41] Fix | Delete

[42] Fix | Delete

static $is_filesystem_setup;

[43] Fix | Delete

[44] Fix | Delete

if ( $is_filesystem_setup ) {

[45] Fix | Delete

return $wp_filesystem;

[46] Fix | Delete

}

[47] Fix | Delete

[48] Fix | Delete

// We have to start the buffer to prevent output

[49] Fix | Delete

// when the file system is ssh/FTP but not configured.

[50] Fix | Delete

ob_start();

[51] Fix | Delete

[52] Fix | Delete

if ( ! function_exists( 'request_filesystem_credentials' ) ) {

[53] Fix | Delete

require_once ABSPATH . 'wp-admin/includes/file.php';

[54] Fix | Delete

}

[55] Fix | Delete

[56] Fix | Delete

// The current page URL.

[57] Fix | Delete

$url = home_url( esc_url_raw( wp_unslash( $_SERVER['REQUEST_URI'] ?? '' ) ) );

[58] Fix | Delete

[59] Fix | Delete

$credentials = request_filesystem_credentials( $url, '', false, false );

[60] Fix | Delete

[61] Fix | Delete

ob_end_clean();

[62] Fix | Delete

[63] Fix | Delete

if ( $credentials === false || ! WP_Filesystem( $credentials ) ) {

[64] Fix | Delete

wpforms_log(

[65] Fix | Delete

'WP_Filesystem Error',

[66] Fix | Delete

'File system isn\'t configured.',

[67] Fix | Delete

[ 'type' => [ 'error' ] ]

[68] Fix | Delete

);

[69] Fix | Delete

[70] Fix | Delete

return null;

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

$is_filesystem_setup = true;

[74] Fix | Delete

[75] Fix | Delete

return $wp_filesystem;

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

/**

[79] Fix | Delete

* Get file contents.

[80] Fix | Delete

[81] Fix | Delete

* @since 1.8.6

[82] Fix | Delete

[83] Fix | Delete

* @param string $file File path.

[84] Fix | Delete

[85] Fix | Delete

* @return string|false

[86] Fix | Delete

[87] Fix | Delete

public static function get_contents( $file ) {

[88] Fix | Delete

[89] Fix | Delete

$filesystem = self::get_filesystem();

[90] Fix | Delete

[91] Fix | Delete

if (

[92] Fix | Delete

! $filesystem

[93] Fix | Delete

|| ! $filesystem->is_readable( $file )

[94] Fix | Delete

|| $filesystem->is_dir( $file )

[95] Fix | Delete

) {

[96] Fix | Delete

return false;

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

return $filesystem->size( $file ) > 0 ? $filesystem->get_contents( $file ) : '';

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

/**

[103] Fix | Delete

* Save file contents.

[104] Fix | Delete

[105] Fix | Delete

* @since 1.8.6

[106] Fix | Delete

[107] Fix | Delete

* @param string $file File path.

[108] Fix | Delete

* @param string $content File content.

[109] Fix | Delete

[110] Fix | Delete

* @return bool

[111] Fix | Delete

[112] Fix | Delete

public static function put_contents( $file, $content ): bool {

[113] Fix | Delete

[114] Fix | Delete

$filesystem = self::get_filesystem();

[115] Fix | Delete

[116] Fix | Delete

if ( ! $filesystem ) {

[117] Fix | Delete

return false;

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

return $filesystem->put_contents( $file, $content );

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

/**

[124] Fix | Delete

* Move a file or files from source to destination.

[125] Fix | Delete

[126] Fix | Delete

* @since 1.8.8

[127] Fix | Delete

[128] Fix | Delete

* @param string $source Source file or glob pattern.

[129] Fix | Delete

* @param string $destination Destination file or directory.

[130] Fix | Delete

[131] Fix | Delete

* @return bool

[132] Fix | Delete

[133] Fix | Delete

public static function move( string $source, string $destination ): bool {

[134] Fix | Delete

[135] Fix | Delete

$filesystem = self::get_filesystem();

[136] Fix | Delete

[137] Fix | Delete

if ( ! $filesystem ) {

[138] Fix | Delete

return false;

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

foreach ( glob( $source ) as $filename ) {

[142] Fix | Delete

$move = $filesystem->move( $filename, $destination . basename( $filename ), true );

[143] Fix | Delete

[144] Fix | Delete

if ( ! $move ) {

[145] Fix | Delete

return false;

[146] Fix | Delete

}

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

return true;

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

/**

[153] Fix | Delete

* Delete a file or directory.

[154] Fix | Delete

[155] Fix | Delete

* @since 1.8.8

[156] Fix | Delete

[157] Fix | Delete

* @param string $file Path to the file or directory.

[158] Fix | Delete

[159] Fix | Delete

* @return bool

[160] Fix | Delete

[161] Fix | Delete

public static function delete( string $file ): bool {

[162] Fix | Delete

[163] Fix | Delete

$filesystem = self::get_filesystem();

[164] Fix | Delete

[165] Fix | Delete

if ( ! $filesystem ) {

[166] Fix | Delete

return false;

[167] Fix | Delete

}

[168] Fix | Delete

[169] Fix | Delete

return $filesystem->delete( $file, true );

[170] Fix | Delete

}

[171] Fix | Delete

[172] Fix | Delete

/**

[173] Fix | Delete

* Create a directory.

[174] Fix | Delete

[175] Fix | Delete

* @since 1.8.8

[176] Fix | Delete

[177] Fix | Delete

* @param string $dir Path directory.

[178] Fix | Delete

[179] Fix | Delete

* @return bool True on success, false on failure. If the directory already exists, this method will return true.

[180] Fix | Delete

[181] Fix | Delete

public static function mkdir( string $dir ): bool {

[182] Fix | Delete

[183] Fix | Delete

$filesystem = self::get_filesystem();

[184] Fix | Delete

[185] Fix | Delete

if ( ! $filesystem ) {

[186] Fix | Delete

return false;

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

if ( $filesystem->is_dir( $dir ) ) {

[190] Fix | Delete

return true;

[191] Fix | Delete

}

[192] Fix | Delete

[193] Fix | Delete

return $filesystem->mkdir( $dir );

[194] Fix | Delete

}

[195] Fix | Delete

[196] Fix | Delete

/**

[197] Fix | Delete

* Gets details for files in a directory or a specific file.

[198] Fix | Delete

[199] Fix | Delete

* @since 1.8.8

[200] Fix | Delete

[201] Fix | Delete

* @param string $dir Path directory.

[202] Fix | Delete

[203] Fix | Delete

* @return array|bool

[204] Fix | Delete

[205] Fix | Delete

public static function dirlist( string $dir ) {

[206] Fix | Delete

[207] Fix | Delete

$filesystem = self::get_filesystem();

[208] Fix | Delete

[209] Fix | Delete

if ( ! $filesystem || ! $filesystem->is_dir( $dir ) ) {

[210] Fix | Delete

return false;

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

return $filesystem->dirlist( $dir, false );

[214] Fix | Delete

}

[215] Fix | Delete

[216] Fix | Delete

/**

[217] Fix | Delete

* Get the upload directory path.

[218] Fix | Delete

[219] Fix | Delete

* @since 1.8.7

[220] Fix | Delete

[221] Fix | Delete

* @return string

[222] Fix | Delete

[223] Fix | Delete

public static function get_upload_dir(): string {

[224] Fix | Delete

[225] Fix | Delete

static $upload_dir;

[226] Fix | Delete

[227] Fix | Delete

if ( $upload_dir ) {

[228] Fix | Delete

/**

[229] Fix | Delete

* Since wpforms_upload_dir() relies on hooks, and hooks can be added unpredictably,

[230] Fix | Delete

* we need to cache the result of this method.

[231] Fix | Delete

* Otherwise, it is the risk to save cache file to one dir and try to get from another.

[232] Fix | Delete

[233] Fix | Delete

return $upload_dir;

[234] Fix | Delete

}

[235] Fix | Delete

[236] Fix | Delete

$wpforms_upload_dir = wpforms_upload_dir();

[237] Fix | Delete

$wpforms_upload_path = ! empty( $wpforms_upload_dir['path'] )

[238] Fix | Delete

? $wpforms_upload_dir['path']

[239] Fix | Delete

: WP_CONTENT_DIR . '/uploads/wpforms';

[240] Fix | Delete

$upload_dir = trailingslashit( wp_normalize_path( $wpforms_upload_path ) );

[241] Fix | Delete

[242] Fix | Delete

return $upload_dir;

[243] Fix | Delete

}

[244] Fix | Delete

[245] Fix | Delete

/**

[246] Fix | Delete

* Get the cache directory path.

[247] Fix | Delete

[248] Fix | Delete

* @since 1.8.6

[249] Fix | Delete

[250] Fix | Delete

* @return string

[251] Fix | Delete

[252] Fix | Delete

public static function get_cache_dir(): string {

[253] Fix | Delete

[254] Fix | Delete

static $cache_dir;

[255] Fix | Delete

[256] Fix | Delete

if ( $cache_dir ) {

[257] Fix | Delete

/**

[258] Fix | Delete

* Since wpforms_upload_dir() relies on hooks, and hooks can be added unpredictably,

[259] Fix | Delete

* we need to cache the result of this method.

[260] Fix | Delete

* Otherwise, it is the risk to save cache file to one dir and try to get from another.

[261] Fix | Delete

[262] Fix | Delete

return $cache_dir;

[263] Fix | Delete

}

[264] Fix | Delete

[265] Fix | Delete

$cache_dir = self::get_upload_dir() . 'cache/';

[266] Fix | Delete

[267] Fix | Delete

return $cache_dir;

[268] Fix | Delete

}

[269] Fix | Delete

[270] Fix | Delete

/**

[271] Fix | Delete

* Check whether the file is already updated.

[272] Fix | Delete

[273] Fix | Delete

* @since 1.8.7

[274] Fix | Delete

[275] Fix | Delete

* @param string $filename Filename.

[276] Fix | Delete

* @param string $cache_key Cache key.

[277] Fix | Delete

[278] Fix | Delete

* @return bool

[279] Fix | Delete

[280] Fix | Delete

public static function is_file_updated( string $filename, string $cache_key = '' ): bool {

[281] Fix | Delete

[282] Fix | Delete

$filename = wp_normalize_path( $filename );

[283] Fix | Delete

$cache_key = $cache_key ? $cache_key : 'wpforms_' . $filename . '_file';

[284] Fix | Delete

[285] Fix | Delete

if ( ! is_file( $filename ) ) {

[286] Fix | Delete

return false;

[287] Fix | Delete

}

[288] Fix | Delete

[289] Fix | Delete

$cached_stat = Transient::get( $cache_key );

[290] Fix | Delete

$stat = array_intersect_key(

[291] Fix | Delete

stat( $filename ),

[292] Fix | Delete

[

[293] Fix | Delete

'size' => 0,

[294] Fix | Delete

'mtime' => 0,

[295] Fix | Delete

'ctime' => 0,

[296] Fix | Delete

]

[297] Fix | Delete

);

[298] Fix | Delete

[299] Fix | Delete

if ( $cached_stat === $stat ) {

[300] Fix | Delete

return true;

[301] Fix | Delete

}

[302] Fix | Delete

[303] Fix | Delete

// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged, WordPress.WP.AlternativeFunctions.unlink_unlink

[304] Fix | Delete

@unlink( $filename );

[305] Fix | Delete

[306] Fix | Delete

return false;

[307] Fix | Delete

}

[308] Fix | Delete

[309] Fix | Delete

/**

[310] Fix | Delete

* Save file updated stat.

[311] Fix | Delete

[312] Fix | Delete

* @since 1.8.7

[313] Fix | Delete

[314] Fix | Delete

* @param string $filename Filename.

[315] Fix | Delete

* @param string $cache_key Cache key.

[316] Fix | Delete

[317] Fix | Delete

* @return void

[318] Fix | Delete

[319] Fix | Delete

public static function save_file_updated_stat( string $filename, string $cache_key = '' ) {

[320] Fix | Delete

[321] Fix | Delete

$filename = wp_normalize_path( $filename );

[322] Fix | Delete

$cache_key = $cache_key ? $cache_key : 'wpforms_' . $filename . '_file';

[323] Fix | Delete

[324] Fix | Delete

clearstatcache( true, $filename );

[325] Fix | Delete

[326] Fix | Delete

$stat = array_intersect_key(

[327] Fix | Delete

stat( $filename ),

[328] Fix | Delete

[

[329] Fix | Delete

'size' => 0,

[330] Fix | Delete

'mtime' => 0,

[331] Fix | Delete

'ctime' => 0,

[332] Fix | Delete

]

[333] Fix | Delete

);

[334] Fix | Delete

[335] Fix | Delete

Transient::set( $cache_key, $stat );

[336] Fix | Delete

}

[337] Fix | Delete

}

[338] Fix | Delete

[339] Fix | Delete