<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Helper functions to work with filesystem, uploads and media files.

[2] Fix | Delete

*

[3] Fix | Delete

* @since 1.8.0

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

use WPForms\Helpers\File;

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Get WPForms upload root path (e.g. /wp-content/uploads/wpforms).

[10] Fix | Delete

*

[11] Fix | Delete

* As of 1.7.0, you can pass in your own value that matches the output of wp_upload_dir()

[12] Fix | Delete

* in order to use this function inside of a filter without infinite looping.

[13] Fix | Delete

*

[14] Fix | Delete

* @since 1.6.1

[15] Fix | Delete

*

[16] Fix | Delete

* @return array WPForms upload root path (no trailing slash).

[17] Fix | Delete

*/

[18] Fix | Delete

function wpforms_upload_dir() {

[19] Fix | Delete

[20] Fix | Delete

$upload_dir = wp_upload_dir();

[21] Fix | Delete

[22] Fix | Delete

if ( ! empty( $upload_dir['error'] ) ) {

[23] Fix | Delete

return [ 'error' => $upload_dir['error'] ];

[24] Fix | Delete

}

[25] Fix | Delete

[26] Fix | Delete

$basedir = wp_is_stream( $upload_dir['basedir'] ) ? $upload_dir['basedir'] : realpath( $upload_dir['basedir'] );

[27] Fix | Delete

$wpforms_upload_root = trailingslashit( $basedir ) . 'wpforms';

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* Allow developers to change a directory where cache and uploaded files will be stored.

[31] Fix | Delete

*

[32] Fix | Delete

* @since 1.5.2

[33] Fix | Delete

*

[34] Fix | Delete

* @param string $wpforms_upload_root WPForms upload root directory.

[35] Fix | Delete

*/

[36] Fix | Delete

$custom_uploads_root = apply_filters( 'wpforms_upload_root', $wpforms_upload_root );

[37] Fix | Delete

[38] Fix | Delete

if ( is_dir( $custom_uploads_root ) && wp_is_writable( $custom_uploads_root ) ) {

[39] Fix | Delete

$wpforms_upload_root = wp_is_stream( $custom_uploads_root )

[40] Fix | Delete

? $custom_uploads_root

[41] Fix | Delete

: realpath( $custom_uploads_root );

[42] Fix | Delete

}

[43] Fix | Delete

[44] Fix | Delete

return [

[45] Fix | Delete

'path' => $wpforms_upload_root,

[46] Fix | Delete

'url' => trailingslashit( $upload_dir['baseurl'] ) . 'wpforms',

[47] Fix | Delete

'error' => false,

[48] Fix | Delete

];

[49] Fix | Delete

}

[50] Fix | Delete

[51] Fix | Delete

/**

[52] Fix | Delete

* Create index.html file in the specified directory if it doesn't exist.

[53] Fix | Delete

*

[54] Fix | Delete

* @since 1.6.1

[55] Fix | Delete

*

[56] Fix | Delete

* @param string $path Path to the directory.

[57] Fix | Delete

*

[58] Fix | Delete

* @return int|false Number of bytes that were written to the file, or false on failure.

[59] Fix | Delete

*/

[60] Fix | Delete

function wpforms_create_index_html_file( $path ) {

[61] Fix | Delete

[62] Fix | Delete

if ( ! is_dir( $path ) || is_link( $path ) ) {

[63] Fix | Delete

return false;

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

$index_file = wp_normalize_path( trailingslashit( $path ) . 'index.html' );

[67] Fix | Delete

[68] Fix | Delete

// Do nothing if index.html exists in the directory.

[69] Fix | Delete

if ( file_exists( $index_file ) ) {

[70] Fix | Delete

return false;

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

// Create empty index.html.

[74] Fix | Delete

return file_put_contents( $index_file, '' ); // phpcs:ignore WordPress.WP.AlternativeFunctions

[75] Fix | Delete

}

[76] Fix | Delete

[77] Fix | Delete

/**

[78] Fix | Delete

* Create index.php file in the specified directory if it doesn't exist.

[79] Fix | Delete

*

[80] Fix | Delete

* @since 1.8.7

[81] Fix | Delete

*

[82] Fix | Delete

* @param string $path Path to the directory.

[83] Fix | Delete

*

[84] Fix | Delete

* @return int|false Number of bytes that were written to the file, or false on failure.

[85] Fix | Delete

*/

[86] Fix | Delete

function wpforms_create_index_php_file( string $path ) {

[87] Fix | Delete

[88] Fix | Delete

if ( ! is_dir( $path ) || is_link( $path ) ) {

[89] Fix | Delete

return false;

[90] Fix | Delete

}

[91] Fix | Delete

[92] Fix | Delete

$index_file = wp_normalize_path( trailingslashit( $path ) . 'index.php' );

[93] Fix | Delete

[94] Fix | Delete

// Do nothing if index.php exists in the directory.

[95] Fix | Delete

if ( file_exists( $index_file ) ) {

[96] Fix | Delete

return false;

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

$data = '<?php

[100] Fix | Delete

header( $_SERVER[\'SERVER_PROTOCOL\'] . \' 404 Not Found\' );

[101] Fix | Delete

header( \'Status: 404 Not Found\' );

[102] Fix | Delete

';

[103] Fix | Delete

[104] Fix | Delete

// Create index.php.

[105] Fix | Delete

return file_put_contents( $index_file, $data ); // phpcs:ignore WordPress.WP.AlternativeFunctions

[106] Fix | Delete

}

[107] Fix | Delete

[108] Fix | Delete

/**

[109] Fix | Delete

* Create .htaccess file in the WPForms upload directory.

[110] Fix | Delete

*

[111] Fix | Delete

* @since 1.6.1

[112] Fix | Delete

*

[113] Fix | Delete

* @return bool True when the .htaccess file exists, false on failure.

[114] Fix | Delete

*/

[115] Fix | Delete

function wpforms_create_upload_dir_htaccess_file(): bool {

[116] Fix | Delete

[117] Fix | Delete

/**

[118] Fix | Delete

* Whether to create upload dir .htaccess file.

[119] Fix | Delete

*

[120] Fix | Delete

* @since 1.6.1

[121] Fix | Delete

*

[122] Fix | Delete

* @param bool $allow True or false.

[123] Fix | Delete

*/

[124] Fix | Delete

if ( ! apply_filters( 'wpforms_create_upload_dir_htaccess_file', true ) ) {

[125] Fix | Delete

return false;

[126] Fix | Delete

}

[127] Fix | Delete

[128] Fix | Delete

$htaccess_file = File::get_upload_dir() . '.htaccess';

[129] Fix | Delete

$cache_key = 'upload_htaccess_file';

[130] Fix | Delete

[131] Fix | Delete

if ( File::is_file_updated( $htaccess_file, $cache_key ) ) {

[132] Fix | Delete

return true;

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

if ( ! function_exists( 'insert_with_markers' ) ) {

[136] Fix | Delete

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

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

/**

[140] Fix | Delete

* Filters upload dir .htaccess file content.

[141] Fix | Delete

*

[142] Fix | Delete

* @since 1.6.1

[143] Fix | Delete

*

[144] Fix | Delete

* @param bool $allow True or false.

[145] Fix | Delete

*/

[146] Fix | Delete

$contents = apply_filters(

[147] Fix | Delete

'wpforms_create_upload_dir_htaccess_file_content',

[148] Fix | Delete

'# Disable PHP and Python scripts parsing.

[149] Fix | Delete

<Files *>

[150] Fix | Delete

SetHandler none

[151] Fix | Delete

SetHandler default-handler

[152] Fix | Delete

RemoveHandler .cgi .php .php3 .php4 .php5 .phtml .pl .py .pyc .pyo

[153] Fix | Delete

RemoveType .cgi .php .php3 .php4 .php5 .phtml .pl .py .pyc .pyo

[154] Fix | Delete

</Files>

[155] Fix | Delete

<IfModule mod_php5.c>

[156] Fix | Delete

php_flag engine off

[157] Fix | Delete

</IfModule>

[158] Fix | Delete

<IfModule mod_php7.c>

[159] Fix | Delete

php_flag engine off

[160] Fix | Delete

</IfModule>

[161] Fix | Delete

<IfModule mod_php8.c>

[162] Fix | Delete

php_flag engine off

[163] Fix | Delete

</IfModule>

[164] Fix | Delete

<IfModule headers_module>

[165] Fix | Delete

Header set X-Robots-Tag "noindex"

[166] Fix | Delete

</IfModule>'

[167] Fix | Delete

);

[168] Fix | Delete

[169] Fix | Delete

$created = insert_with_markers( $htaccess_file, 'WPForms', $contents );

[170] Fix | Delete

[171] Fix | Delete

if ( $created ) {

[172] Fix | Delete

File::save_file_updated_stat( $htaccess_file, $cache_key );

[173] Fix | Delete

}

[174] Fix | Delete

[175] Fix | Delete

return $created;

[176] Fix | Delete

}

[177] Fix | Delete

[178] Fix | Delete

/**

[179] Fix | Delete

* Create .htaccess file in the WPForms cache directory.

[180] Fix | Delete

*

[181] Fix | Delete

* @since 1.8.7

[182] Fix | Delete

*

[183] Fix | Delete

* @return bool True when the .htaccess file exists, false on failure.

[184] Fix | Delete

*/

[185] Fix | Delete

function wpforms_create_cache_dir_htaccess_file(): bool {

[186] Fix | Delete

[187] Fix | Delete

/**

[188] Fix | Delete

* Whether to create cache dir .htaccess file.

[189] Fix | Delete

*

[190] Fix | Delete

* @since 1.8.7

[191] Fix | Delete

*

[192] Fix | Delete

* @param bool $allow True or false.

[193] Fix | Delete

*/

[194] Fix | Delete

if ( ! apply_filters( 'wpforms_create_cache_dir_htaccess_file', true ) ) {

[195] Fix | Delete

return false;

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

$htaccess_file = File::get_cache_dir() . '.htaccess';

[199] Fix | Delete

[200] Fix | Delete

if ( File::is_file_updated( $htaccess_file, 'cache_htaccess_file' ) ) {

[201] Fix | Delete

return true;

[202] Fix | Delete

}

[203] Fix | Delete

[204] Fix | Delete

if ( ! function_exists( 'insert_with_markers' ) ) {

[205] Fix | Delete

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

[206] Fix | Delete

}

[207] Fix | Delete

[208] Fix | Delete

/**

[209] Fix | Delete

* Filters cache dir .htaccess file content.

[210] Fix | Delete

*

[211] Fix | Delete

* @since 1.8.7

[212] Fix | Delete

*

[213] Fix | Delete

* @param bool $allow True or false.

[214] Fix | Delete

*/

[215] Fix | Delete

$contents = apply_filters(

[216] Fix | Delete

'wpforms_create_cache_dir_htaccess_file_content',

[217] Fix | Delete

'# Disable access for any file in the cache dir.

[218] Fix | Delete

# Apache 2.2

[219] Fix | Delete

<IfModule !authz_core_module>

[220] Fix | Delete

Deny from all

[221] Fix | Delete

</IfModule>

[222] Fix | Delete

[223] Fix | Delete

# Apache 2.4+

[224] Fix | Delete

<IfModule authz_core_module>

[225] Fix | Delete

Require all denied

[226] Fix | Delete

</IfModule>'

[227] Fix | Delete

);

[228] Fix | Delete

[229] Fix | Delete

$created = insert_with_markers( $htaccess_file, 'WPForms', $contents );

[230] Fix | Delete

[231] Fix | Delete

if ( $created ) {

[232] Fix | Delete

File::save_file_updated_stat( $htaccess_file );

[233] Fix | Delete

}

[234] Fix | Delete

[235] Fix | Delete

return $created;

[236] Fix | Delete

}

[237] Fix | Delete

[238] Fix | Delete

/**

[239] Fix | Delete

* Convert a file size provided, such as "2M", to bytes.

[240] Fix | Delete

*

[241] Fix | Delete

* @link http://stackoverflow.com/a/22500394

[242] Fix | Delete

*

[243] Fix | Delete

* @since 1.0.0

[244] Fix | Delete

*

[245] Fix | Delete

* @param string $size File size.

[246] Fix | Delete

*

[247] Fix | Delete

* @return int

[248] Fix | Delete

*/

[249] Fix | Delete

function wpforms_size_to_bytes( $size ) {

[250] Fix | Delete

[251] Fix | Delete

if ( is_numeric( $size ) ) {

[252] Fix | Delete

return $size;

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

$suffix = substr( $size, - 1 );

[256] Fix | Delete

$value = substr( $size, 0, - 1 );

[257] Fix | Delete

[258] Fix | Delete

switch ( strtoupper( $suffix ) ) {

[259] Fix | Delete

case 'P':

[260] Fix | Delete

$value *= 1024;

[261] Fix | Delete

[262] Fix | Delete

case 'T':

[263] Fix | Delete

$value *= 1024;

[264] Fix | Delete

[265] Fix | Delete

case 'G':

[266] Fix | Delete

$value *= 1024;

[267] Fix | Delete

[268] Fix | Delete

case 'M':

[269] Fix | Delete

$value *= 1024;

[270] Fix | Delete

[271] Fix | Delete

case 'K':

[272] Fix | Delete

$value *= 1024;

[273] Fix | Delete

break;

[274] Fix | Delete

}

[275] Fix | Delete

[276] Fix | Delete

return $value;

[277] Fix | Delete

}

[278] Fix | Delete

[279] Fix | Delete

/**

[280] Fix | Delete

* Convert a file size provided, such as "2M", to bytes.

[281] Fix | Delete

*

[282] Fix | Delete

* @link http://stackoverflow.com/a/22500394

[283] Fix | Delete

*

[284] Fix | Delete

* @since 1.0.0

[285] Fix | Delete

*

[286] Fix | Delete

* @param bool $bytes Whether the value should be in bytes or formatted.

[287] Fix | Delete

*

[288] Fix | Delete

* @return false|string|int

[289] Fix | Delete

*/

[290] Fix | Delete

function wpforms_max_upload( $bytes = false ) {

[291] Fix | Delete

[292] Fix | Delete

$max = wp_max_upload_size();

[293] Fix | Delete

[294] Fix | Delete

if ( $bytes ) {

[295] Fix | Delete

return $max;

[296] Fix | Delete

}

[297] Fix | Delete

[298] Fix | Delete

return size_format( $max );

[299] Fix | Delete

}

[300] Fix | Delete

[301] Fix | Delete