Ubuntu
title = __( 'Check if your files and folders have the correct write permissions (chmod).', 'secupress' );
$this->more = __( 'CHMOD is the way to give read/write/execute rights to a file or a folder. The 0777 value is bad and should be avoided. This test will check some strategic files and folders.', 'secupress' );
$this->more_fix = __( 'Change the files permissions to the recommended one for each.', 'secupress' );
}
/**
* Get messages.
*
* @since 1.0
*
* @param (int) $message_id A message ID.
*
* @return (string|array) A message if a message ID is provided. An array containing all messages otherwise.
*/
public static function get_messages( $message_id = null ) {
$messages = array(
// "good"
0 => __( 'All file permissions are good.', 'secupress' ),
1 => __( 'All file permissions are fixed.', 'secupress' ),
// "warning"
100 => __( 'Unable to determine the file permissions of %s.', 'secupress' ),
// "bad"
202 => _nx_noop(
'File permissions for the following folder should be %1$s: %2$s.',
'File permissions for the following folders should be %1$s: %2$s.',
'1: chmod required, 2: folder path(s)',
'secupress'
),
203 => _nx_noop(
'File permissions for the following file should be %1$s: %2$s.',
'File permissions for the following files should be %1$s: %2$s.',
'1: chmod required, 2: folder path(s)',
'secupress'
),
204 => _n_noop(
'Unable to apply new permissions to the file or folder %s.',
'Unable to apply new permissions to the files or folders %s.',
'secupress'
),
// DEPRECATED, NOT IN USE ANYMORE.
200 => _x( 'File permissions for %1$s should be %2$s, NOT %3$s!', '1: file path, 2: chmod required, 3: current chmod', 'secupress' ),
201 => __( 'Unable to apply new file permissions to %s.', 'secupress' ),
);
if ( isset( $message_id ) ) {
return isset( $messages[ $message_id ] ) ? $messages[ $message_id ] : __( 'Unknown message', 'secupress' );
}
return $messages;
}
/** Getters. ================================================================================ */
/**
* Get the documentation URL.
*
* @since 1.2.3
*
* @return (string)
*/
public static function get_docs_url() {
return __( 'http://docs.secupress.me/article/125-file-permission-scan', 'secupress' );
}
/** Scan. =================================================================================== */
/**
* Scan for flaw(s).
*
* @since 1.0
*
* @return (array) The scan results.
*/
public function scan() {
$activated = secupress_filter_scanner( __CLASS__ );
if ( true === $activated ) {
$this->add_message( 0 );
return parent::scan();
}
$warnings = array();
$folders = array();
$files = array();
$to_test = $this->get_files();
$abspath = realpath( ABSPATH );
clearstatcache();
// Folders.
foreach ( $to_test['folders'] as $file_path ) {
// Current folder perm.
$file_path = realpath( $file_path );
$current_chmod = fileperms( $file_path ) & 0777;
$file_relative = ltrim( str_replace( $abspath, '', $file_path ), '\\' );
$file_relative = '' === $file_relative ? '/' : $file_relative;
if ( ! $current_chmod ) {
// "warning": unable to determine folder perm.
$warnings[] = sprintf( '%s', $file_relative );
} elseif ( $current_chmod > $this->folder_chmod ) {
// "bad".
$folders[] = sprintf( '%s (%s)', $file_relative, static::to_octal( $current_chmod ) );
}
}
// Files.
if ( $to_test['files'] ) {
foreach ( $to_test['files'] as $file_path ) {
// Current file perm.
$file_path = realpath( $file_path );
$current_chmod = fileperms( $file_path ) & 0777;
$file_relative = ltrim( str_replace( $abspath, '', $file_path ), '\\' );
$file_relative = '' === $file_relative ? '/' : $file_relative;
if ( ! $current_chmod ) {
// "warning": unable to determine file perm.
$warnings[] = sprintf( '%s', $file_relative );
} elseif ( $current_chmod > $this->file_chmod ) {
// "bad".
$files[] = sprintf( '%s (%s)', $file_relative, static::to_octal( $current_chmod ) );
}
}
}
if ( $folders ) {
// "bad"
$this->add_message( 202, array( count( $folders ), sprintf( '%s', static::to_octal( $this->folder_chmod ) ), $folders ) );
}
if ( $files ) {
// "bad"
$this->add_message( 203, array( count( $files ), sprintf( '%s', static::to_octal( $this->file_chmod ) ), $files ) );
}
if ( $warnings ) {
// "warning"
$this->add_message( 100, array( $warnings ) );
}
// "good"
$this->maybe_set_status( 0 );
return parent::scan();
}
/** Fix. ==================================================================================== */
/**
* Try to fix the flaw(s).
*
* @since 1.4.5
*
* @return (array) The fix results.
*/
public function need_manual_fix() {
return [ 'fix' => 'fix' ];
}
/**
* Get an array containing ALL the forms that would fix the scan if it requires user action.
*
* @since 1.4.5
*
* @return (array) An array of HTML templates (form contents most of the time).
*/
protected function get_fix_action_template_parts() {
return [ 'fix' => ' ' ];
}
/**
* Try to fix the flaw(s) after requiring user action.
*
* @since 1.4.5
*
* @return (array) The fix results.
*/
public function manual_fix() {
if ( $this->has_fix_action_part( 'fix' ) ) {
$this->fix();
}
// "good"
$this->add_fix_message( 1 );
return parent::manual_fix();
}
/**
* Try to fix the flaw(s).
*
* @since 1.0
*
* @return (array) The fix results.
*/
public function fix() {
$warnings = array();
$files = array();
$failed = array();
$to_test = $this->get_files();
$abspath = realpath( ABSPATH );
$filesystem = secupress_get_filesystem();
clearstatcache();
// Folders.
foreach ( $to_test['folders'] as $file_path ) {
// Current folder perm.
$current_chmod = fileperms( $file_path ) & 0777;
if ( ! $current_chmod || $current_chmod > $this->folder_chmod ) {
// Apply new folder perm.
$filesystem->chmod( $file_path, $this->folder_chmod );
$files[ $file_path ] = $this->folder_chmod;
}
}
// Files.
if ( $to_test['files'] ) {
foreach ( $to_test['files'] as $file_path ) {
// Current file perm.
$current_chmod = fileperms( $file_path ) & 0777;
if ( ! $current_chmod || $current_chmod > $this->file_chmod ) {
// Apply new file perm.
$filesystem->chmod( $file_path, $this->file_chmod );
$files[ $file_path ] = $this->file_chmod;
}
}
}
// Check if it worked.
clearstatcache();
if ( ! $files ) {
// "good" (there was nothing to fix).
$this->add_fix_message( 0 );
return parent::fix();
}
if ( $files ) {
foreach ( $files as $file_path => $target_chmod ) {
// Current file perm.
$file_path = realpath( $file_path );
$current_chmod = fileperms( $file_path ) & 0777;
$file_relative = ltrim( str_replace( $abspath, '', $file_path ), '\\' );
$file_relative = '' === $file_relative ? '/' : $file_relative;
if ( ! $current_chmod ) {
// "warning": unable to determine file perm.
$warnings[] = sprintf( '%s', $file_relative );
} elseif ( $current_chmod > $target_chmod ) {
// "bad": unable to apply the file perm.
$failed[] = sprintf( '%s (%s)', $file_relative, static::to_octal( $target_chmod ) );
}
}
}
if ( $failed ) {
// "bad"
$this->add_fix_message( 204, array( count( $failed ), $failed ) );
}
if ( $warnings ) {
// "warning"
$this->add_fix_message( 100, array( $warnings ) );
}
// "good"
$this->maybe_set_fix_status( 1 );
return parent::fix();
}
/** Tools. ================================================================================== */
/**
* Get files and folders to test, categorized by type.
*
* @since 1.2.2
*
* @return (array) An array of arrays of paths.
*/
protected function get_files() {
$upload_dir = wp_upload_dir();
$wpconfig_filepath = secupress_find_wpconfig_path();
$files = array(
'folders' => array(
ABSPATH,
ABSPATH . 'wp-admin',
ABSPATH . WPINC,
WP_CONTENT_DIR,
get_theme_root(),
WP_PLUGIN_DIR,
$upload_dir['basedir'],
),
'files' => array(),
);
if ( file_exists( WPMU_PLUGIN_DIR ) ) {
$files['folders'][] = WPMU_PLUGIN_DIR;
}
$files['folders'] = array_map( 'trailingslashit', $files['folders'] );
if ( $wpconfig_filepath ) {
$files['files'][] = $wpconfig_filepath;
}
if ( file_exists( ABSPATH . '.htaccess' ) ) {
$files['files'][] = ABSPATH . '.htaccess';
}
if ( file_exists( ABSPATH . 'web.config' ) ) {
$files['files'][] = ABSPATH . 'web.config';
}
return $files;
}
/**
* Transform an "octal" integer to a "readable" string like "0644".
*
* @since 1.2.2
*
* @param (int) $int An "octal" integer.
*
* @return (string).
*/
protected static function to_octal( $int ) {
return substr( '0' . decoct( $int ), -4 );
}
}