Ubuntu
'scanners',
'singleton' => 'common',
'logs' => 'common',
'log' => 'common',
'cleanup-leftovers' => 'common',
'scanner-results' => 'common',
);
$prefix = strtolower( str_replace( '_', '-', $prefix ) );
$folder = isset( $folders[ $prefix ] ) ? $folders[ $prefix ] : $prefix;
$class_name_part = strtolower( str_replace( '_', '-', $class_name_part ) );
$class_name_part = $class_name_part ? '-' . $class_name_part : '';
return SECUPRESS_CLASSES_PATH . $folder . '/class-secupress-' . $prefix . $class_name_part . '.php';
}
/**
* Require a class.
*
* @since 1.0
*
* @param (string) $prefix Only one possible value so far: "scan".
* @param (string) $class_name_part The classes name is built as follow: "SecuPress_{$prefix}_{$class_name_part}".
*/
function secupress_require_class( $prefix, $class_name_part = '' ) {
$path = secupress_class_path( $prefix, $class_name_part );
if ( $path ) {
require_once( $path );
}
}
/**
* Will load the async classes.
*
* @since 1.0
*/
function secupress_require_class_async() {
/* https://github.com/A5hleyRich/wp-background-processing v1.0 */
secupress_require_class( 'Admin', 'wp-async-request' );
secupress_require_class( 'Admin', 'wp-background-process' );
}
/** --------------------------------------------------------------------------------------------- */
/** SCAN / FIX ================================================================================== */
/** --------------------------------------------------------------------------------------------- */
/**
* Return all tests to scan
*
* @since 1.0
*
* @return (array) Tests to scan.
*/
function secupress_get_scanners() {
$tests = array(
'users-login' => array(
0 => 'Admin_User',
1 => 'Easy_Login',
2 => 'Subscription',
3 => 'Passwords_Strength',
4 => 'Bad_Usernames',
5 => 'Login_Errors_Disclose',
),
'plugins-themes' => array(
0 => 'Plugins_Update',
1 => 'Themes_Update',
2 => 'Bad_Old_Plugins',
3 => 'Bad_Vuln_Plugins',
4 => 'Inactive_Plugins_Themes',
),
'wordpress-core' => array(
0 => 'Core_Update',
1 => 'Auto_Update',
2 => 'Bad_Old_Files',
3 => 'Bad_Config_Files',
4 => 'WP_Config',
5 => 'DB_Prefix',
6 => 'Salt_Keys',
7 => 'WPOrg',
),
'sensitive-data' => array(
0 => 'Discloses',
1 => 'Readme_Discloses',
2 => 'PHP_Disclosure',
3 => 'HTTPS',
),
'file-system' => array(
0 => 'Chmods',
1 => 'Directory_Listing',
2 => 'Bad_File_Extensions',
),
'firewall' => array(
0 => 'Shellshock',
1 => 'Bad_User_Agent',
2 => 'SQLi',
3 => 'Anti_Scanner',
// 4 => '', // ex-Anti_Front_Brute_Force, do not reuse "4"!
5 => 'Bad_Request_Methods',
6 => 'Bad_Url_Access',
7 => 'PhpVersion',
8 => 'Php_404',
),
);
// 3rd party.
if ( class_exists( 'SitePress' ) ) {
$tests['sensitive-data'][3] = 'Wpml_Discloses';
}
if ( class_exists( 'WooCommerce' ) ) {
$tests['sensitive-data'][4] = 'Woocommerce_Discloses';
}
return apply_filters( 'secupress.scanner.tests', $tests );
}
/**
* Get tests that can't be fixes from the network admin.
*
* @since 1.0
*
* @return (array) Array of "class name parts".
*/
function secupress_get_tests_for_ms_scanner_fixes() {
return array(
'Bad_Old_Plugins',
'Subscription',
);
}
/**
* Get SecuPress scanner counter(s).
*
* @since 1.0
*
* @param (string) $type Info to retrieve: good, warning, bad, notscannedyet, grade, total.
*
* @return (string|array) The desired counter info if `$type` is provided and the info exists. An array of all counters otherwise.
*/
function secupress_get_scanner_counts( $type = '' ) {
$tests_by_status = secupress_get_scanners();
$scanners = secupress_get_scan_results();
$fixes = secupress_get_fix_results();
$empty_statuses = array( 'good' => 0, 'warning' => 0, 'bad' => 0 );
$scanners_count = $scanners ? array_count_values( wp_list_pluck( $scanners, 'status' ) ) : array();
$counts = array_merge( $empty_statuses, $scanners_count );
$total = array_sum( array_map( 'count', $tests_by_status ) );
$counts['notscannedyet'] = $total - array_sum( $counts );
$counts['total'] = $total;
$counts['percent'] = (int) floor( $counts['good'] * 100 / $counts['total'] );
$counts['hasaction'] = 0;
if ( $fixes ) {
foreach ( $fixes as $test_name => $fix ) {
if ( ! empty( $fix['has_action'] ) ) {
++$counts['hasaction'];
}
}
}
if ( 100 === $counts['percent'] ) {
$counts['grade'] = 'A';
} elseif ( $counts['percent'] >= 80 ) { // 20 less
$counts['grade'] = 'B';
} elseif ( $counts['percent'] >= 65 ) { // 15 less
$counts['grade'] = 'C';
} elseif ( $counts['percent'] >= 52 ) { // 13 less
$counts['grade'] = 'D';
} elseif ( $counts['percent'] >= 42 ) { // 10 less
$counts['grade'] = 'E';
} elseif ( $counts['percent'] >= 34 ) { // 8 less
$counts['grade'] = 'F';
} elseif ( $counts['percent'] >= 28 ) { // 6 less
$counts['grade'] = 'G';
} elseif ( $counts['percent'] >= 22 ) { // 6 less
$counts['grade'] = 'H';
} elseif ( $counts['percent'] >= 16 ) { // 6 less
$counts['grade'] = 'I';
} elseif ( $counts['percent'] >= 10 ) { // 6 less
$counts['grade'] = 'J';
} elseif ( 0 === $counts['percent'] ) { // (ᕗ‶⇀︹↼)ᕗ彡┻━┻
$counts['grade'] = '∅';
} else {
$counts['grade'] = 'K'; // < 10 %
}
$counts['letter'] = '' . $counts['grade'] . '';
$counts['color'] = '195,34,34';
switch ( $counts['grade'] ) {
case 'A':
$counts['text'] = __( 'Congratulations! 🎉', 'secupress' );
$counts['color'] = '43,205,193';
break;
case 'B':
$counts['text'] = __( 'Almost perfect!', 'secupress' );
$counts['color'] = '241,196,15';
break;
case 'C':
$counts['text'] = __( 'Not bad, but try to fix more items.', 'secupress' );
$counts['color'] = '247,171,19';
break;
case 'D':
$counts['text'] = __( 'Well, it\'s not good yet.', 'secupress' );
$counts['color'] = '242,41,94';
break;
case 'E':
$counts['text'] = __( 'Better than nothing, but still not good.', 'secupress' );
$counts['color'] = '203,35,79';
break;
case 'F':
$counts['text'] = __( 'Not good at all, fix more issues.', 'secupress' );
break;
case 'G':
$counts['text'] = __( 'Bad, fix issues right away!', 'secupress' );
break;
case 'H':
$counts['text'] = __( 'Still very bad, start fixing things!', 'secupress' );
break;
case 'I':
$counts['text'] = __( 'Very bad. You should take some actions.', 'secupress' );
break;
case 'J':
$counts['text'] = __( 'Very very bad, please fix something!', 'secupress' );
break;
case 'K':
$counts['text'] = __( 'Very very, really very bad.', 'secupress' );
break;
case '∅':
$counts['text'] = '(ᕗ‶⇀︹↼)ᕗ彡┻━┻'; // Easter egg if you got 0% (how is this possible oO).
break;
}
$counts['subtext'] = sprintf( _n( 'Your grade is %1$s — %2$d scanned item is good.', 'Your grade is %1$s — %2$d scanned items are good.', $counts['good'], 'secupress' ), $counts['letter'], $counts['good'] );
if ( $type ) {
// Make sure to not return the whole array if a type is given, even if it isn't set.
return isset( $counts[ $type ] ) ? $counts[ $type ] : '';
}
return $counts;
}
/**
* Tell if we can perform "extra fix actions" (something we do on page reload after a fix is done).
*
* @since 1.2.3
*
* @return (bool)
*/
function secupress_can_perform_extra_fix_action() {
global $pagenow;
return empty( $_POST ) && ! defined( 'DOING_AJAX' ) && ! defined( 'DOING_AUTOSAVE' ) && is_admin() && 'admin-post.php' !== $pagenow && is_user_logged_in(); // WPCS: CSRF ok.
}
/** --------------------------------------------------------------------------------------------- */
/** PLUGINS ===================================================================================== */
/** --------------------------------------------------------------------------------------------- */
/**
* Check whether a plugin is active.
*
* @since 1.0
*
* @param (string) $plugin A plugin path, relative to the plugins folder.
*
* @return (bool)
*/
function secupress_is_plugin_active( $plugin ) {
$plugins = (array) get_option( 'active_plugins', array() );
$plugins = array_flip( $plugins );
return isset( $plugins[ $plugin ] ) || secupress_is_plugin_active_for_network( $plugin );
}
/**
* Check whether a plugin is active for the entire network.
*
* @since 1.0
*
* @param (string) $plugin A plugin path, relative to the plugins folder.
*
* @return (bool)
*/
function secupress_is_plugin_active_for_network( $plugin ) {
if ( ! is_multisite() ) {
return false;
}
$plugins = get_site_option( 'active_sitewide_plugins' );
return isset( $plugins[ $plugin ] );
}
/** --------------------------------------------------------------------------------------------- */
/** DIE ========================================================================================= */
/** --------------------------------------------------------------------------------------------- */
/**
* Die with SecuPress format.
*
* @since 1.0
*
* @param (string) $message Guess what.
* @param (string) $title Window title.
* @param (array) $args An array of arguments.
*/
function secupress_die( $message = '', $title = '', $args = array() ) {
$has_p = strpos( $message, '' ) !== false;
$message = ( $has_p ? '' : '
' ) . $message . ( $has_p ? '' : '
' );
$message = '' . SECUPRESS_PLUGIN_NAME . '
' . $message;
$url = secupress_get_current_url( 'raw' );
$force_die = ! empty( $args['force_die'] );
$is_scan_request = secupress_is_scan_request(); // Used to bypass the whitelist for scans.
/**
* Filter the message.
*
* @since 1.0
*
* @param (string) $message The message displayed.
* @param (string) $url The current URL.
* @param (array) $args Facultative arguments.
* @param (bool) $is_scan_request Tell if the request comes from one of our scans.
*/
$message = apply_filters( 'secupress.die.message', $message, $url, $args, $is_scan_request );
/**
* Fires right before `wp_die()`.
*
* @since 1.0
*
* @param (string) $message The message displayed.
* @param (string) $url The current URL.
* @param (array) $args Facultative arguments.
* @param (bool) $is_scan_request Tell if the request comes from one of our scans.
*/
do_action( 'secupress.before.die', $message, $url, $args, $is_scan_request );
if ( $force_die || $is_scan_request ) {
// Die.
if ( ! defined( 'DONOTCACHEPAGE' ) ) {
// Tell cache plugins not to cache our error message.
define( 'DONOTCACHEPAGE', true );
}
wp_die( $message, $title, $args );
}
}
/**
* Block a request and die with more informations.
*
* @since 1.0
*
* @param (string) $module The related module.
* @param (array|int|string) $args Contains the "code" (def. 403) and a "content" (def. empty), this content will replace the default message.
* $args can be used only for the "code" or "content" or both using an array.
*/
function secupress_block( $module, $args = array( 'code' => 403 ) ) {
$ip = secupress_get_ip();
/**
* Allow to give a proper name to the block ID.
*
* @since 1.1.4
*
* @param (string) $module The related module.
*/
$block_id = apply_filters( 'secupress_block_id', $module );
if ( $block_id === $module ) {
$block_id = ucwords( str_replace( '-', ' ', $block_id ) );
$block_id = preg_replace( '/[^0-9A-Z]/', '', $block_id );
}
if ( is_int( $args ) ) {
$args = array( 'code' => (int) $args ); // Cast to prevent recursion.
} elseif ( is_string( $args ) ) {
$args = array( 'content' => (string) $args ); // Cast to prevent recursion.
}
$args = wp_parse_args( $args, array( 'code' => 403, 'content' => '', 'b64' => [] ) );
// Add some hardcoded b64 args to be printed for support help.
$args['b64']['URL'] = secupress_get_current_url( 'raw' );
$args['b64']['SP'] = secupress_has_pro() ? 'Pro v' . SECUPRESS_PRO_VERSION : 'Free v' . SECUPRESS_VERSION;
$args['b64']['ID'] = $module;
/**
* Fires before a user is blocked by a certain module.
*
* @since 1.0
* @since 1.1.4 Added `$block_id` argument.
*
* @param (string) $ip The IP address.
* @param (array) $args Contains the "code" (def. 403) and a "content" (def. empty), this content will replace the default message.
* @param (string) $block_id The block ID.
*/
do_action( 'secupress.block.' . $module, $ip, $args, $block_id );
/**
* Fires before a user is blocked.
*
* @since 1.0
* @since 1.1.4 Added `$block_id` argument.
*
* @param (string) $module The module.
* @param (string) $ip The IP address.
* @param (array) $args Contains the "code" (def. 403) and a "content" (def. empty), this content will replace the default message.
* @param (string) $block_id The block ID.
*/
do_action( 'secupress.block', $module, $ip, $args, $block_id );
$title = $args['code'] . ' ' . get_status_header_desc( $args['code'] );
$content = '' . $title . '
';
if ( ! $args['content'] ) {
$content .= '' . __( 'You are not allowed to access the requested page.', 'secupress' ) . '
';
} else {
$content .= '' . $args['content'] . '
';
}
$content .= '' . __( 'Logged Details:', 'secupress' ) . '
';
$content .= '';
$content .= sprintf( __( 'Your IP: %s', 'secupress' ), $ip ) . '
';
$content .= sprintf( __( 'Time: %s', 'secupress' ), date_i18n( __( 'F j, Y g:i a', 'secupress' ) ) ) . '
';
$content .= sprintf( __( 'Reason: %s', 'secupress' ), $block_id ) . '
';
$content .= sprintf( __( 'Support ID: %s', 'secupress' ), '' ) . '
';
$content .= '
';
secupress_die( $content, $title, array( 'response' => $args['code'], 'force_die' => true ) );
}
/**
* Tell if the request comes from one of our scans by detecting a specific header.
* Careful, this header can be forged, the result is not trustful.
*
* @since 1.0
* @author Grégory Viguier
*
* @return (bool) True if the request comes from a scan. False otherwize.
*/
function secupress_is_scan_request() {
return ! empty( $_SERVER['HTTP_X_SECUPRESS_ORIGIN'] );
}
/** --------------------------------------------------------------------------------------------- */
/** OTHER TOOLS ================================================================================= */
/** --------------------------------------------------------------------------------------------- */
/**
* Create a URL to easily access to our pages.
*
* @since 1.4.4 'get-pro' $page is now returning the external URL
* @since 1.0
*
* @param (string) $page The last word of the secupress page slug.
* @param (string) $module The required module.
*
* @return (string) The URL.
*/
function secupress_admin_url( $page, $module = '' ) {
if ( 'get-pro' === $page ) {
return SECUPRESS_WEB_MAIN . __( 'pricing', 'secupress' );
}
$module = $module ? '&module=' . $module : '';
$page = str_replace( '&', '_', $page );
$url = 'admin.php?page=' . SECUPRESS_PLUGIN_SLUG . '_' . $page . $module;
return is_multisite() ? network_admin_url( $url ) : admin_url( $url );
}
/**
* Get the user capability/role required to work with the plugin.
*
* @since 1.0
*
* @param (bool) $force_mono Set to true to get the capability/role for monosite, whatever we're on multisite or not.
*
* @return (string) The capability.
*/
function secupress_get_capability( $force_mono = false ) {
if ( ! $force_mono && is_multisite() ) {
return 'manage_network_options';
}
$role = 'administrator';
/**
* Filter the user capability/role that gives access to SecuPress features.
*
* @since 1.0
*
* @param (string) $role The user capability/role.
*/
return apply_filters( 'secupress.user_capability', $role );
}
/**
* Add SecuPress informations into USER_AGENT.
*
* @since 1.0
* @since 1.1.4 Available in global scope.
*
* @param (string) $user_agent A User Agent.
*
* @return (string)
*/
function secupress_user_agent( $user_agent ) {
$bonus = secupress_is_white_label() ? '*' : '';
$bonus .= secupress_get_option( 'do_beta' ) ? '+' : '';
$new_ua = sprintf( '%s;SecuPress|%s%s|%s|;', $user_agent, SECUPRESS_VERSION, $bonus, esc_url( secupress_get_main_url() ) );
return $new_ua;
}
/**
* Get the site main URL. Will be the same for any site of a network, and for any lang of a multilang site.
*
* @since 1.2.2
* @author Grégory Viguier
*
* @return (string) The URL.
*/
function secupress_get_main_url() {
$current_network = false;
if ( function_exists( 'get_network' ) ) {
$current_network = get_network();
} elseif ( function_exists( 'get_current_site' ) ) {
$current_network = get_current_site();
}
if ( ! $current_network ) {
if ( function_exists( '__get_option' ) ) {
if ( __get_option( 'siteurl' ) ) {
return __get_option( 'siteurl' );
}
} else {
return get_option( 'siteurl' );
}
}
$scheme = is_ssl() ? 'https' : 'http';
$main_url = set_url_scheme( 'http://' . $current_network->domain . $current_network->path, $scheme );
return untrailingslashit( $main_url );
}
/**
* Is this version White Labeled?
*
* @since 1.0
* @since 1.1.4 Available in global scope.
*
* @return (bool)
*/
function secupress_is_white_label() {
if ( ! secupress_is_pro() ) {
return false;
}
$names = array( 'wl_plugin_name', 'wl_plugin_URI', 'wl_description', 'wl_author', 'wl_author_URI' );
foreach ( $names as $value ) {
if ( false !== secupress_get_option( $value ) ) {
return true;
}
}
return false;
}
/**
* Get SecuPress logo.
*
* @since 1.0
* @since 1.0.6 Remove the yellow Pro logo (Julio Potier)
*
* @param (array) $atts An array of HTML attributes.
*
* @author Geoffrey Crofte
* @return (string) The HTML tag.
*/
function secupress_get_logo( $atts = array() ) {
if ( secupress_is_white_label() ) {
/**
* If white label is activated, no SecuPress logo is retrieve, let the filter do the job.
*
* @since 1.4.2
*
* @param (string) Should return a ![]()
or dashicon span tag.
* @param (array) $atts Attributes, contains logo size.
*/
return apply_filters( 'secupress.white_label.logo', '', $atts );
}
$base_url = SECUPRESS_ADMIN_IMAGES_URL . 'logo';
$atts = array_merge( array(
'src' => "{$base_url}.png",
'srcset' => "{$base_url}2x.svg 1x, {$base_url}2x.svg 2x",
'alt' => '',
), $atts );
$attributes = '';
foreach ( $atts as $att => $value ) {
$attributes .= " {$att}=\"{$value}\"";
}
return "";
}
/**
* Get SecuPress logo word.
*
* @since 1.0
*
* @param (array) $atts An array of HTML attributes.
*
* @return (string) The HTML tag.
*/
function secupress_get_logo_word( $atts = array() ) {
if ( SECUPRESS_PLUGIN_NAME !== 'SecuPress' ) {
return SECUPRESS_PLUGIN_NAME;
}
$base_url = SECUPRESS_ADMIN_IMAGES_URL . 'secupress-word';
$atts = array_merge( array(
'src' => "{$base_url}.png",
'srcset' => "{$base_url}.svg 1x, {$base_url}.svg 2x",
'alt' => 'SecuPress',
), $atts );
$attributes = '';
foreach ( $atts as $att => $value ) {
$attributes .= " {$att}=\"{$value}\"";
}
return "";
}
/**
* Tell if users can register, whatever we're in a Multisite or not.
*
* @since 1.0
*
* @return (bool)
*/
function secupress_users_can_register() {
if ( ! is_multisite() ) {
return (bool) get_option( 'users_can_register' );
}
$registration = get_site_option( 'registration' );
return 'user' === $registration || 'all' === $registration;
}
/**
* Get the email address used when the plugin send a message.
*
* @since 1.0
*
* @param (bool) $from_header True to return the "from" header.
*
* @return (string)
*/
function secupress_get_email( $from_header = false ) {
$sitename = strtolower( $_SERVER['SERVER_NAME'] );
if ( substr( $sitename, 0, 4 ) === 'www.' ) {
$sitename = substr( $sitename, 4 );
}
/**
* Give the possibility to replace the "from" email address
*
* @since 1.4
*
* @param (string) noreply@sitename by default@
*/
$email = apply_filters( 'secupress.get_email', 'noreply@' . $sitename );
return $from_header ? 'from: ' . SECUPRESS_PLUGIN_NAME . ' <' . $email . '>' : $email;
}
/**
* Send mail.
*
* @since 1.2.4
* @author Grégory Viguier
*
* @param (string|array) $to Array or comma-separated list of email addresses to send message.
* @param (string) $subject Email subject.
* @param (string) $message Message contents.
* @param (array) $headers Optional. Additional headers.
* @param (string|array) $attachments Optional. Files to attach.
*
* @return (bool) Whether the email contents were sent successfully.
*/
function secupress_send_mail( $to, $subject, $message, $headers = array(), $attachments = array() ) {
$blogname = secupress_get_blogname();
// Subject.
$subject = str_replace( '###SITENAME###', $blogname, $subject );
$subject = wp_specialchars_decode( $subject );
// Message.
$message = str_replace( '###SITENAME###', $blogname, $message );
// Headers.
$headers = array_merge( array(
'from' => secupress_get_email( true ),
'content-type' => 'content-type: text/html',
), $headers );
return wp_mail( $to, $subject, $message, $headers, $attachments );
}
/**
* Get the blog name or host if empty.
*
* @since 1.4.9
*
* @return (string)
*/
function secupress_get_blogname() {
static $blogname;
if ( ! isset( $blogname ) ) {
/**
* The blogname option is escaped with esc_html on the way into the database in sanitize_option
* we want to reverse this for the plain text arena of emails.
*/
$blogname = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
$blogname = $blogname ?: parse_url( home_url(), PHP_URL_HOST );
}
return $blogname;
}
/**
* Return the current URL.
*
* @since 1.0
*
* @param (string) $mode What to return: raw (all), base (before '?'), uri (before '?', without the domain).
*
* @return (string)
*/
function secupress_get_current_url( $mode = 'base' ) {
$mode = (string) $mode;
$port = (int) $_SERVER['SERVER_PORT'];
$port = 80 !== $port && 443 !== $port ? ( ':' . $port ) : '';
$url = ! empty( $GLOBALS['HTTP_SERVER_VARS']['REQUEST_URI'] ) ? $GLOBALS['HTTP_SERVER_VARS']['REQUEST_URI'] : ( ! empty( $_SERVER['REQUEST_URI'] ) ? $_SERVER['REQUEST_URI'] : '' );
$url = 'http' . ( is_ssl() ? 's' : '' ) . '://' . $_SERVER['HTTP_HOST'] . $port . $url;
switch ( $mode ) :
case 'raw' :
return $url;
case 'uri' :
$home = set_url_scheme( home_url() );
$url = explode( '?', $url, 2 );
$url = reset( $url );
$url = str_replace( $home, '', $url );
return trim( $url, '/' );
default :
$url = explode( '?', $url, 2 );
return reset( $url );
endswitch;
}
/**
* Store, get or delete static data.
* Getter: no need to provide a second parameter.
* Setter: provide a second parameter for the value.
* Deletter: provide null as second parameter to remove the previous value.
*
* @since 1.0
*
* @param (string) $key An identifier key.
*
* @return (mixed) The stored data or null.
*/
function secupress_cache_data( $key ) {
static $data = array();
$func_get_args = func_get_args();
if ( array_key_exists( 1, $func_get_args ) ) {
if ( null === $func_get_args[1] ) {
unset( $data[ $key ] );
} else {
$data[ $key ] = $func_get_args[1];
}
}
return isset( $data[ $key ] ) ? $data[ $key ] : null;
}
/**
* Get the main blog ID.
*
* @since 1.0
*
* @return (int)
*/
function secupress_get_main_blog_id() {
static $blog_id;
if ( ! isset( $blog_id ) ) {
if ( ! is_multisite() ) {
$blog_id = 1;
}
elseif ( ! empty( $GLOBALS['current_site']->blog_id ) ) {
$blog_id = absint( $GLOBALS['current_site']->blog_id );
}
elseif ( defined( 'BLOG_ID_CURRENT_SITE' ) ) {
$blog_id = absint( BLOG_ID_CURRENT_SITE );
}
$blog_id = ! empty( $blog_id ) ? $blog_id : 1;
}
return $blog_id;
}
/**
* Is current WordPress version older than X.X.X?
*
* @since 1.0
*
* @param (string) $version The version to test.
*
* @return (bool) Result of the `version_compare()`.
*/
function secupress_wp_version_is( $version ) {
global $wp_version;
static $is = array();
if ( isset( $is[ $version ] ) ) {
return $is[ $version ];
}
return ( $is[ $version ] = version_compare( $wp_version, $version ) >= 0 );
}
/**
* Check whether WordPress is in "installation" mode.
*
* @since 1.0
*
* @return (bool) true if WP is installing, otherwise false.
*/
function secupress_wp_installing() {
return function_exists( 'wp_installing' ) ? wp_installing() : defined( 'WP_INSTALLING' ) && WP_INSTALLING;
}
/**
* Tell if the site frontend is served over SSL.
*
* @since 1.0
*
* @return (bool)
**/
function secupress_is_site_ssl() {
static $is_site_ssl;
if ( isset( $is_site_ssl ) ) {
return $is_site_ssl;
}
if ( is_multisite() ) {
switch_to_blog( secupress_get_main_blog_id() );
$site_url = get_option( 'siteurl' );
$home_url = get_option( 'home' );
restore_current_blog();
} else {
$site_url = get_option( 'siteurl' );
$home_url = get_option( 'home' );
}
$is_site_ssl = strpos( $site_url, 'https://' ) === 0 && strpos( $home_url, 'https://' ) === 0;
/**
* Filter the value of `$is_site_ssl`, that tells if the site frontend is served over SSL.
*
* @since 1.0
*
* @param (bool) $is_site_ssl True if the site frontend is served over SSL.
*/
$is_site_ssl = apply_filters( 'secupress.front.is_site_ssl', $is_site_ssl );
return $is_site_ssl;
}
/**
* Like in_array but for nested arrays.
*
* @since 1.0
*
* @param (mixed) $needle The value to find.
* @param (array) $haystack The array to search.
*
* @return (bool)
*/
function secupress_in_array_deep( $needle, $haystack ) {
if ( $haystack ) {
foreach ( $haystack as $item ) {
if ( $item === $needle || ( is_array( $item ) && secupress_in_array_deep( $needle, $item ) ) ) {
return true;
}
}
}
return false;
}
/**
* `array_intersect_key()` + `array_merge()`.
*
* @since 1.0
* @author Grégory Viguier
*
* @param (array) $values The array we're interested in.
* @param (array) $default The array we use as boudaries.
*
* @return (array)
*/
function secupress_array_merge_intersect( $values, $default ) {
$values = array_merge( $default, $values );
return array_intersect_key( $values, $default );
}
/**
* Tell if the consumer email is valid.
*
* @since 1.0
*
* @return (string|bool) The email if it is valid. False otherwise.
*/
function secupress_get_consumer_email() {
return is_email( secupress_get_option( 'consumer_email' ) );
}
/**
* Get the consumer key (if the consumer email is ok).
*
* @since 1.0
*
* @return (string)
*/
function secupress_get_consumer_key() {
return secupress_get_consumer_email() ? secupress_get_option( 'consumer_key' ) : '';
}
/**
* Return true if secupress pro is activated.
*
* @since 1.0
*
* @return (bool)
*/
function secupress_has_pro() {
return defined( 'SECUPRESS_PRO_VERSION' );
}
/**
* Return true if the license is ok.
*
* @since 1.3
* @author Grégory Viguier
*
* @return (bool)
*/
function secupress_has_pro_license() {
static $has_pro;
if ( ! isset( $has_pro ) ) {
$has_pro = secupress_get_consumer_key() && secupress_get_option( 'site_is_pro' );
}
return $has_pro;
}
/**
* Return true if secupress pro is installed and the license is ok.
*
* @since 1.0
*
* @return (bool)
*/
function secupress_is_pro() {
return secupress_has_pro() && secupress_has_pro_license();
}
/**
* Tell if a feature is for pro version.
*
* @since 1.0
*
* @param (string) $feature The feature to test. Basically it can be:
* - A field "name" when the whole field is pro: the result of `$this->get_field_name( $field_name )`.
* - A field "name + value" when only one (or some) of the values is pro: the result of `$this->get_field_name( $field_name ) . "|" . $value`.
*
* @return (bool) True if the feature is in the white-list.
*/
function secupress_feature_is_pro( $feature ) {
$features = array(
// Field names.
'login-protection_sessions_control' => 1,
'blacklist-logins_prevent-user-creation' => 1,
'double-auth_type' => 1,
'password-policy_password_expiration' => 1,
'password-policy_strong_passwords' => 1,
'plugins_activation' => 1,
'plugins_deactivation' => 1,
'plugins_deletion' => 1,
'plugins_detect_bad_plugins' => 1,
'themes_activation' => 1,
'themes_deletion' => 1,
'themes_detect_bad_themes' => 1,
'uploads_uploads' => 1,
'page-protect_profile' => 1,
'page-protect_settings' => 1,
'content-protect_hotlink' => 1,
'file-scanner_file-scanner' => 1,
'bad-file-extensions_activated' => 1,
'backup-files_backup-file' => 1,
'backup-db_backup-db' => 1,
'backup-history_backup-history' => 1,
'import-export_export_settings' => 1,
'import-export_import_settings' => 1,
'geoip-system_type' => 1,
'schedules-backups_type' => 1,
'schedules-backups_periodicity' => 1,
'schedules-backups_email' => 1,
'schedules-backups_scheduled' => 1,
'schedules-scan_type' => 1,
'schedules-scan_periodicity' => 1,
'schedules-scan_email' => 1,
'schedules-scan_scheduled' => 1,
'schedules-file-monitoring_type' => 1,
'schedules-file-monitoring_periodicity' => 1,
'schedules-file-monitoring_email' => 1,
'schedules-file-monitoring_scheduled' => 1,
'notification-types_types' => 1,
'alerts_activated' => 1,
'backups-storage_location' => 1,
'event-alerts_activated' => 1,
'notification-types_emails' => 1,
'daily-reporting_activated' => 1,
'move-login_whattodo|custom_error' => 1,
'move-login_whattodo|custom_page' => 1,
);
return isset( $features[ $feature ] );
}
/**
* Tell if a user is affected by its role for the asked module.
*
* @since 1.0
*
* @param (string) $module A module.
* @param (string) $submodule A sub-module.
* @param (object) $user A WP_User object.
*
* @return (-1|bool) -1 = every role is affected, true = the user's role is affected, false = the user's role isn't affected.
*/
function secupress_is_affected_role( $module, $submodule, $user ) {
$roles = secupress_get_module_option( $submodule . '_affected_role', array(), $module );
if ( ! $roles ) {
return -1;
}
return secupress_is_user( $user ) && ! array_intersect( $roles, $user->roles );
}
/**
* This will be used with the filter hook 'nonce_user_logged_out' to create nonces for disconnected users.
*
* @since 1.0
*
* @param (int) $uid A userID.
*
* @return (int)
*/
function secupress_modify_userid_for_nonces( $uid ) {
if ( $uid ) {
return $uid;
}
return isset( $_GET['userid'] ) ? (int) $_GET['userid'] : 0;
}
/**
* Tell if the param $user is a real user from your installation.
*
* @since 1.0
* @author Julio Potier
*
* @param (mixed) $user The object to be tested to be a valid user.
*
* @return (bool)
*/
function secupress_is_user( $user ) {
return is_a( $user, 'WP_User' ) && user_can( $user, 'exist' );
}
/**
* Compress some data to be stored in the database.
*
* @since 1.0.6
*
* @param (mixed) $data The data to compress.
*
* @return (string) The compressed data.
*/
function secupress_compress_data( $data ) {
/** Little and gentle obfuscation to avoid being tagged as "malicious script", I hope you understand :) — Julio. */
$gz = 'eta';
$gz = 'gz' . strrev( $gz . 'lfed' );
$bsf = 'cne';
$bsf = strrev( 'edo' . $bsf );
$bsf = '64_' . $bsf;
$bsf = 'base' . $bsf;
return $bsf// Hey.
( $gz// Hoy.
( serialize( $data ) ) );
}
/**
* Decompress some data coming from the database.
*
* @since 1.0.6
*
* @param (string) $data The data to decompress.
*
* @return (mixed) The decompressed data.
*/
function secupress_decompress_data( $data ) {
if ( ! $data || ! is_string( $data ) ) {
return $data;
}
/** Little and gentle obfuscation to avoid being tagged as "malicious script", I hope you understand :) — Julio. */
$gz = 'eta';
$gz = 'gz' . strrev( $gz . 'lfni' );
$bsf = 'ced';
$bsf = strrev( 'edo' . $bsf );
$bsf = '64_' . $bsf;
$bsf = 'base' . $bsf;
$data_tmp = $bsf// Hey.
( $data );
if ( ! $data_tmp ) {
return $data;
}
$data = $data_tmp;
$data_tmp = $gz// Hoy.
( $data );
if ( ! $data_tmp ) {
return $data;
}
return maybe_unserialize( $data_tmp );
}
/**
* Try to increase the memory limit if possible.
*
* @since 1.0
* @author Grégory Viguier
*/
function secupress_maybe_increase_memory_limit() {
if ( ! wp_is_ini_value_changeable( 'memory_limit' ) ) {
return;
}
$limits = array(
'64M' => 67108864,
'128M' => 134217728,
'256M' => 268435456,
);
$current_limit = @ini_get( 'memory_limit' );
$current_limit_int = wp_convert_hr_to_bytes( $current_limit );
if ( -1 === $current_limit_int || $current_limit_int > $limits['256M'] ) {
return;
}
foreach ( $limits as $limit => $bytes ) {
if ( $current_limit_int < $bytes ) {
@ini_set( 'memory_limit', $limit );
return;
}
}
}
/**
* Register a settings error to be displayed to the user.
* This a clone of `add_settings_error()`, but available in the global scope.
*
* @since 1.3
* @author Grégory Viguier
*
* @param (string) $setting Slug title of the setting to which this error applies.
* @param (string) $code Slug-name to identify the error. Used as part of 'id' attribute in HTML output.
* @param (string) $message The formatted message text to display to the user (will be shown inside styled
* `` and `
` tags).
* @param (string) $type Optional. Message type, controls HTML class. Accepts 'error' or 'updated'.
* Default 'error'.
*/
function secupress_add_settings_error( $setting, $code, $message, $type = 'error' ) {
global $wp_settings_errors;
$wp_settings_errors[] = array(
'setting' => $setting,
'code' => $code,
'message' => $message,
'type' => $type,
);
}
/**
* Fetch settings errors registered by `add_settings_error()` and `secupress_add_settings_error()`.
* This a clone of `get_settings_errors()`, but available in the global scope.
*
* @since 1.3
* @author Grégory Viguier
*
* @param (string) $setting Optional slug title of a specific setting who's errors you want.
* @param (boolean) $sanitize Whether to re-sanitize the setting value before returning errors.
*
* @return (array) Array of settings errors
*/
function secupress_get_settings_errors( $setting = '', $sanitize = false ) {
global $wp_settings_errors;
/**
* If `$sanitize` is true, manually re-run the sanitization for this option.
* This allows the $sanitize_callback from register_setting() to run, adding any settings errors you want to show by default.
*/
if ( $sanitize ) {
sanitize_option( $setting, get_option( $setting ) );
}
// If settings were passed back from options.php then use them.
if ( isset( $_GET['settings-updated'] ) && $_GET['settings-updated'] && get_transient( 'settings_errors' ) ) {
$wp_settings_errors = array_merge( (array) $wp_settings_errors, get_transient( 'settings_errors' ) ); // WPCS: override ok.
delete_transient( 'settings_errors' );
}
// Check global in case errors have been added on this pageload.
if ( is_array( $wp_settings_errors ) && ! count( $wp_settings_errors ) ) {
return array();
}
// Filter the results to those of a specific setting if one was set.
if ( $setting ) {
$setting_errors = array();
foreach ( (array) $wp_settings_errors as $key => $details ) {
if ( $setting === $details['setting'] ) {
$setting_errors[] = $wp_settings_errors[ $key ];
}
}
return $setting_errors;
}
return $wp_settings_errors;
}
/**
* Checks whether function is disabled.
*
* @since 1.4.5
* @author Grégory Viguier
*
* @param (string) $function Name of the function.
* @return (bool) Whether or not the function is disabled.
*/
function secupress_is_function_disabled( $function ) {
if ( ! function_exists( $function ) ) {
return true;
}
$disabled = explode( ',', @ini_get( 'disable_functions' ) );
$disabled = array_map( 'trim', $disabled );
$disabled = array_flip( $disabled );
return isset( $disabled[ $function ] );
}
/**
* Returns true if SECUPRESS_MODE is defined on "expert" or "dev" (if you are a dev, you're an expert, right?)
*
* @since 1.4.6
* @return (bool)
* @author Julio Potier
**/
function secupress_is_expert_mode() {
return defined( 'SECUPRESS_MODE' ) && ( 'expert' === strtolower( SECUPRESS_MODE )|| 'dev' === strtolower( SECUPRESS_MODE ) );
}
/**
* Returns true if SECUPRESS_MODE is defined on "dev"
*
* @since 1.4.6
* @return (bool)
* @author Julio Potier
**/
function secupress_is_dev_mode() {
return defined( 'SECUPRESS_MODE' ) && 'dev' === strtolower( SECUPRESS_MODE );
}