JezK

Edit File: functions.php

<?php defined( 'ABSPATH' ) or die(); /** * Only functions also required on front-end here */ /** * Get a Really Simple Security option by name * * @param string $name The name of the option to retrieve. * @param mixed $default_value The default value to return if the option does not exist. * * @return mixed */ if (!function_exists('rsssl_get_option')) { function rsssl_get_option( string $name, $default_value = false ) { $name = sanitize_title( $name ); if ( is_multisite() && rsssl_is_networkwide_active() ) { $options = get_site_option( 'rsssl_options', [] ); } else { $options = get_option( 'rsssl_options', [] ); } //fallback, will be removed after 6.2 //because we only check if the option is not saved in the new style, this if should normally never get executed. if ( ! isset( $options[ $name ] ) && ( 'ssl_enabled' === $name || 'redirect' === $name || 'mixed_content_fixer' === $name || 'dismiss_all_notices' === $name ) ) { $options = rsssl_get_legacy_option( $options, $name ); } $value = $options[ $name ] ?? false; if ( false === $value && false !== $default_value ) { $value = $default_value; } if ( 1 === $value ) { $value = true; } return apply_filters( "rsssl_option_$name", $value, $name ); } } if (!function_exists('rsssl_get_cache')) { function rsssl_get_cache( $key, string $group = 'default', $default = false, $blog_id = false ) { $key = (string) $key; $group = rsssl_cache_group_name($group); $cache = rsssl_get_cache_storage(); $scope = rsssl_get_cache_scope($cache, $group, $blog_id); if (!isset($scope[$key])) { return $default; } if (!is_array($scope[$key])) { rsssl_delete_cache($key, $group, $blog_id); return $default; } $data = $scope[$key]; $expires = isset($data['expires']) ? (int) $data['expires'] : 0; if ($expires > 0 && $expires <= time()) { rsssl_delete_cache($key, $group, $blog_id); return $default; } return isset($data['value']) ? $data['value'] : $default; } } if (!function_exists('rsssl_set_cache')) { function rsssl_set_cache( $key, $value, string $group = 'default', int $expiration = 0, $blog_id = false ): bool { $key = (string) $key; $group = rsssl_cache_group_name($group); $cache = rsssl_get_cache_storage(); $data = array( 'value' => $value, 'expires' => $expiration > 0 ? time() + $expiration : 0, ); rsssl_set_cache_entry($cache, $key, $group, $data, $blog_id); return rsssl_update_cache($cache); } } if (!function_exists('rsssl_delete_cache')) { function rsssl_delete_cache( $key, string $group = 'default', $blog_id = false ): bool { $key = (string) $key; $group = rsssl_cache_group_name($group); $cache = rsssl_get_cache_storage(); if ($blog_id !== false) { $blog_id = (int) $blog_id; if (!isset($cache[$group]['blogs'][$blog_id][$key])) { return false; } unset($cache[$group]['blogs'][$blog_id][$key]); if (empty($cache[$group]['blogs'][$blog_id])) { unset($cache[$group]['blogs'][$blog_id]); } if (empty($cache[$group]['global']) && empty($cache[$group]['blogs'])) { unset($cache[$group]); } return rsssl_update_cache($cache); } if (!isset($cache[$group]['global'][$key])) { return false; } unset($cache[$group]['global'][$key]); if (empty($cache[$group]['global']) && empty($cache[$group]['blogs'])) { unset($cache[$group]); } return rsssl_update_cache($cache); } } if (!function_exists('rsssl_delete_cache_group')) { function rsssl_delete_cache_group( string $group = 'default', $blog_id = false ): bool { $group = rsssl_cache_group_name($group); $cache = rsssl_get_cache_storage(); if (!isset($cache[$group])) { return false; } if ($blog_id !== false) { $blog_id = (int) $blog_id; if (!isset($cache[$group]['blogs'][$blog_id])) { return false; } unset($cache[$group]['blogs'][$blog_id]); if (empty($cache[$group]['global']) && empty($cache[$group]['blogs'])) { unset($cache[$group]); } return rsssl_update_cache($cache); } unset($cache[$group]); return rsssl_update_cache($cache); } } if (!function_exists('rsssl_get_cache_storage')) { function rsssl_get_cache_storage(): array { $cache = get_site_option('rsssl_cache', array()); $cache = is_array($cache) ? $cache : array(); foreach ($cache as $group => $group_cache) { if (!is_array($group_cache)) { unset($cache[$group]); continue; } $cache[$group]['global'] = isset($group_cache['global']) && is_array($group_cache['global']) ? $group_cache['global'] : array(); $cache[$group]['blogs'] = isset($group_cache['blogs']) && is_array($group_cache['blogs']) ? $group_cache['blogs'] : array(); } return $cache; } } if (!function_exists('rsssl_get_cache_scope')) { function rsssl_get_cache_scope( array $cache, string $group, $blog_id = false ): array { if (!isset($cache[$group]) || !is_array($cache[$group])) { return array(); } if ($blog_id !== false) { $blog_id = (int) $blog_id; return isset($cache[$group]['blogs'][$blog_id]) && is_array($cache[$group]['blogs'][$blog_id]) ? $cache[$group]['blogs'][$blog_id] : array(); } return isset($cache[$group]['global']) && is_array($cache[$group]['global']) ? $cache[$group]['global'] : array(); } } if (!function_exists('rsssl_set_cache_entry')) { function rsssl_set_cache_entry( array &$cache, string $key, string $group, array $data, $blog_id = false ) { if (!isset($cache[$group]) || !is_array($cache[$group])) { $cache[$group] = array( 'global' => array(), 'blogs' => array(), ); } if (!isset($cache[$group]['global']) || !is_array($cache[$group]['global'])) { $cache[$group]['global'] = array(); } if (!isset($cache[$group]['blogs']) || !is_array($cache[$group]['blogs'])) { $cache[$group]['blogs'] = array(); } if ($blog_id !== false) { $blog_id = (int) $blog_id; if (!isset($cache[$group]['blogs'][$blog_id]) || !is_array($cache[$group]['blogs'][$blog_id])) { $cache[$group]['blogs'][$blog_id] = array(); } $cache[$group]['blogs'][$blog_id][$key] = $data; return; } $cache[$group]['global'][$key] = $data; } } if (!function_exists('rsssl_update_cache')) { function rsssl_update_cache( array $cache ): bool { return update_site_option('rsssl_cache', $cache); } } if (!function_exists('rsssl_cache_group_name')) { function rsssl_cache_group_name( string $group ): string { $group = trim($group); return $group !== '' ? $group : 'default'; } } if (!function_exists('rsssl_upgrade_migrate_cache_entry')) { function rsssl_upgrade_migrate_cache_entry( string $legacy_option, string $legacy_key, string $group = 'default', ?string $target_key = null, bool $legacy_site_option = true, $blog_id = false ) { $target_key = $target_key ?: $legacy_key; $group = rsssl_cache_group_name($group); $cache = rsssl_get_cache_storage(); $scope = rsssl_get_cache_scope($cache, $group, $blog_id); $legacy_cache = $legacy_site_option ? get_site_option($legacy_option, array()) : get_option($legacy_option, array()); $legacy_scope = $legacy_cache; if ($blog_id !== false && $legacy_site_option) { $blog_id = (int) $blog_id; $legacy_scope = isset($legacy_cache[$blog_id]) && is_array($legacy_cache[$blog_id]) ? $legacy_cache[$blog_id] : array(); } if (!is_array($legacy_scope) || !isset($legacy_scope[$legacy_key])) { return; } if (isset($scope[$target_key])) { rsssl_upgrade_delete_legacy_cache_entry($legacy_option, $legacy_key, $legacy_cache, $legacy_site_option, $blog_id); return; } if (!is_array($legacy_scope[$legacy_key])) { rsssl_upgrade_delete_legacy_cache_entry($legacy_option, $legacy_key, $legacy_cache, $legacy_site_option, $blog_id); return; } $data = $legacy_scope[$legacy_key]; $expires = isset($data['expires']) ? (int) $data['expires'] : 0; if ($expires === 0 || $expires > time()) { rsssl_set_cache_entry($cache, $target_key, $group, $data, $blog_id); rsssl_update_cache($cache); rsssl_upgrade_delete_legacy_cache_entry($legacy_option, $legacy_key, $legacy_cache, $legacy_site_option, $blog_id); return; } rsssl_upgrade_delete_legacy_cache_entry($legacy_option, $legacy_key, $legacy_cache, $legacy_site_option, $blog_id); } } if (!function_exists('rsssl_upgrade_delete_legacy_cache_entry')) { function rsssl_upgrade_delete_legacy_cache_entry( string $legacy_option, string $legacy_key, array $legacy_cache, bool $legacy_site_option = true, $blog_id = false ) { if ($blog_id !== false && $legacy_site_option) { $blog_id = (int) $blog_id; if (isset($legacy_cache[$blog_id]) && is_array($legacy_cache[$blog_id])) { unset($legacy_cache[$blog_id][$legacy_key]); if (empty($legacy_cache[$blog_id])) { unset($legacy_cache[$blog_id]); } } } else { unset($legacy_cache[$legacy_key]); } if ($legacy_site_option) { update_site_option($legacy_option, $legacy_cache); } else { update_option($legacy_option, $legacy_cache, false); } } } if (!function_exists('rsssl_upgrade_delete_legacy_cache_option')) { function rsssl_upgrade_delete_legacy_cache_option( string $legacy_option, bool $legacy_site_option = true ) { $legacy_cache = $legacy_site_option ? get_site_option($legacy_option, array()) : get_option($legacy_option, array()); if (is_array($legacy_cache) && empty($legacy_cache)) { if ($legacy_site_option) { delete_site_option($legacy_option); } else { delete_option($legacy_option); } } } } /** * Check if we should treat the plugin as networkwide or not. * Note that this function returns false for single sites! Always use icw is_multisite() * * @return bool */ if (!function_exists('rsssl_is_networkwide_active')) { function rsssl_is_networkwide_active() { if ( ! is_multisite() ) { return false; } if ( ! function_exists( 'is_plugin_active_for_network' ) ) { require_once ABSPATH . '/wp-admin/includes/plugin.php'; } if ( is_plugin_active_for_network( rsssl_plugin ) ) { return true; } return false; } } /** * if the option is does not exist in our new array, check if it's available in the old option. If so, use that one * @deprecated to be used until 6.2, as fallback for failed upgrades in some specific edge case situations * @param array|bool $options * @param string $name * * @return array */ if (!function_exists('rsssl_get_legacy_option')) { function rsssl_get_legacy_option( $options, string $name ): array { $old_options = is_multisite() ? get_site_option( 'rlrsssl_network_options' ) : get_option( 'rlrsssl_options' ); $options = []; if ( $old_options ) { if ( 'ssl_enabled' === $name && isset( $old_options['ssl_enabled'] ) ) { $options['ssl_enabled'] = $old_options['ssl_enabled']; } elseif ( 'dismiss_all_notices' === $name && isset( $old_options['dismiss_all_notices'] ) ) { $options['dismiss_all_notices'] = $old_options['dismiss_all_notices']; } elseif ( 'dismiss_all_notices' === $name && isset( $old_options['dismiss_all_notices'] ) ) { $options['dismiss_all_notices'] = $old_options['dismiss_all_notices']; } elseif ( 'mixed_content_fixer' === $name && isset( $old_options['autoreplace_insecure_links'] ) ) { $options['mixed_content_fixer'] = $old_options['autoreplace_insecure_links']; } elseif ( 'redirect' === $name ) { if ( isset( $old_options['htaccess_redirect'] ) && $old_options['htaccess_redirect'] ) { $options['redirect'] = 'htaccess'; } elseif ( isset( $old_options['wp_redirect'] ) && $old_options['wp_redirect'] ) { $options['redirect'] = 'wp_redirect'; } } } return $options; } } if (!function_exists('rsssl_check_if_email_essential_feature')) { function rsssl_check_if_email_essential_feature() { $essential_features = array( 'limit_login_attempts' => rsssl_get_option( 'enable_limited_login_attempts' ) == 1,//phpcs:ignore 'login_protection_enabled' => rsssl_get_option( 'login_protection_enabled' ) == 1,//phpcs:ignore ); // Check if the current feature is in the essential features array foreach ( $essential_features as $is_essential ) { if ( $is_essential ) { return true; } } return false; } } /** * Retrieves the path to a template file. * * @param string $template The name of the template to retrieve. * @param string $path (Optional) The path to look for the template file. If not specified, the default path will be used. * * @return string The full path to the template file. * @throws \RuntimeException Throws a runtime exception if the template file cannot be found. */ if (!function_exists('rsssl_get_template')) { function rsssl_get_template( string $template, string $path = '' ): string { // Define the path in the theme where templates can be overridden. $theme_template_path = get_stylesheet_directory() . '/really-simple-ssl-templates/' . $template; // Check if the theme has an override for the template. if ( file_exists( $theme_template_path ) ) { return $theme_template_path; } // If $path is not set, use the default path if ( $path === '' ) { $path = rsssl_path . 'templates/'; // Remember this only works in free version, for pro we need to add the $path parameter/argument } else { // Ensure the path ends with a slash $path = trailingslashit( $path ); } // Full path to the template file $full_path = $path . $template; // Check if the template exists in the specified path. if ( ! file_exists( $full_path ) ) { throw new \RuntimeException( 'Template not found: ' . $full_path ); } return $full_path; } } /** * Loads a template file and includes it. * * @param string $template The name of the template to load. * @param array $vars (Optional) An associative array of variables to make available in the template scope. * @param string $path (Optional) The path to look for the template file. If not specified, the default path will be used. * * @return void * @throws Exception Throws an exception if the template file cannot be found. */ if (!function_exists('rsssl_load_template')) { function rsssl_load_template( string $template, array $vars = array(), string $path = '' ) { // Extract variables to be available in the template scope. if ( is_array( $vars ) ) { extract( $vars ); } // Get the template file, checking for theme overrides. $template_file = rsssl_get_template( $template, $path ); // Include the template file. include $template_file; } } /** * Determines the path to WordPress configuration file (wp-config.php) * * This function attempts to locate the wp-config.php file in the following order: * 1. Checks for a filtered path via 'rsssl_wpconfig_path' filter * 2. Looks in the WordPress installation root directory (ABSPATH) * 3. Looks in the parent directory of the WordPress installation * * @return string The full path to wp-config.php if found, empty string otherwise * * @filter rsssl_wpconfig_path Allows modification of the wp-config.php path * * @example * // Get wp-config.php path * $config_path = rsssl_wpconfig_path(); * * // Filter example * add_filter('rsssl_wpconfig_path', function($path) { * return '/custom/path/to/wp-config.php'; * }); */ if ( ! function_exists( 'rsssl_wpconfig_path' ) ) { function rsssl_wpconfig_path(): string { // Allow the wp-config.php path to be overridden via a filter. $filtered_path = apply_filters( 'rsssl_wpconfig_path', '' ); // If a filtered path is provided and valid, use it. if ( ! empty( $filtered_path ) && file_exists( $filtered_path ) ) { return $filtered_path; } // Default behavior to locate wp-config.php $location_of_wp_config = ABSPATH; if ( ! file_exists( ABSPATH . 'wp-config.php' ) && file_exists( dirname( ABSPATH ) . '/wp-config.php' ) ) { $location_of_wp_config = dirname( ABSPATH ); } $location_of_wp_config = trailingslashit( $location_of_wp_config ); $wpconfig_path = $location_of_wp_config . 'wp-config.php'; // Check if the file exists and return the path if valid. if ( file_exists( $wpconfig_path ) ) { return $wpconfig_path; } // Return an empty string if no valid wp-config.php path is found. return ''; } } /** * @return void * * Set encryption keys */ if ( ! function_exists('rsssl_set_encryption_key')) { function rsssl_set_encryption_key(): void { // Return if the key has already been defined if ( defined( 'RSSSL_KEY' ) ) { return; } $key = get_site_option( 'rsssl_main_key' ); $wp_config_path = rsssl_wpconfig_path(); // If we have a DB key, and the wp-config.php is not writable, return if ( $key && ! is_writable( $wp_config_path ) ) { return; } $new_generated = false; // If we don't have a key, generate one if ( ! $key ) { // Ensure wp_generate_password() is available if ( ! function_exists( 'wp_generate_password' ) ) { require_once ABSPATH . WPINC . '/pluggable.php'; } $new_generated = true; $key = wp_generate_password( 64, false ); } if ( is_writable( $wp_config_path ) ) { // Add the key to the wp-config file $rule = "//Begin Really Simple Security key\n"; $rule .= "define('RSSSL_KEY', '" . $key . "');\n"; $rule .= "//END Really Simple Security key\n"; $insert_after = '<?php'; $contents = file_get_contents( $wp_config_path ); $pos = strpos( $contents, $insert_after ); if ( false !== $pos && strpos( $contents, 'RSSSL_KEY' ) === false ) { $contents = substr_replace( $contents, $rule, $pos + 1 + strlen( $insert_after ), 0 ); file_put_contents( $wp_config_path, $contents, LOCK_EX ); // Define the constant for the current request. wp-config.php // won't be re-parsed until next request. if ( ! defined( 'RSSSL_KEY' ) ) { define( 'RSSSL_KEY', $key ); } } // If the wp-config was just set to writable, we can delete the key from the database now. delete_site_option( 'rsssl_main_key' ); } elseif ( $new_generated ) { // If we can't write to the wp-config file, store the key in the database // When wp-config is set to writable, auto upgrade to constant update_site_option( 'rsssl_main_key', $key, false ); } update_site_option( 'rsssl_encryption_keys_set', true ); } rsssl_set_encryption_key(); } /** * Handle resending the verification e-mail. */ if ( ! function_exists('rsssl_resend_verification_email') ) { function rsssl_resend_verification_email() { if ( ! rsssl_user_can_manage() ) { return; } if ( ! isset( $_POST['rsssl_resend_email_nonce'] ) || ! wp_verify_nonce( $_POST['rsssl_resend_email_nonce'], 'rsssl_resend_verification_email_nonce' ) ) { wp_die(); } $mailer = new rsssl_mailer(); $mailer->send_verification_mail(); wp_send_json_success(); } } /** * Handle the force confirm email action. */ if ( ! function_exists('rsssl_handle_force_confirm_email') ) { function rsssl_handle_force_confirm_email(): void { if ( ! rsssl_user_can_manage() ) { return; } if ( ! isset( $_POST['rsssl_force_email_action_nonce'] ) || ! wp_verify_nonce( $_POST['rsssl_force_email_action_nonce'], 'rsssl_force_confirm_email_nonce' ) ) { wp_die(); } update_option( 'rsssl_email_verification_status', 'completed', false ); wp_send_json_success(); } } /** * Add JavaScript for email verification and re-send buttons. */ if ( ! function_exists('rsssl_generate_email_verification_buttons_js') ) { function rsssl_generate_email_verification_buttons_js(): void { if (!rsssl_user_can_manage()) { return; } ?> <script type="text/javascript"> jQuery(document).ready(function($) { // Force confirm button handler $(document).on('click', '#rsssl-force-confirm', function(e) { e.preventDefault(); var button = $(this); button.prop('disabled', true); $.ajax({ url: ajaxurl, type: 'POST', data: { action: 'rsssl_force_confirm_email', rsssl_force_email_action_nonce: '<?php echo wp_create_nonce('rsssl_force_confirm_email_nonce'); ?>' }, success: function(response) { if (response.success) { location.reload(); } } }); }); // Resend verification email button handler $(document).on('click', '#rsssl-resend-verification', function(e) { e.preventDefault(); var button = $(this); button.prop('disabled', true); button.text('<?php echo esc_js(__('Sending...', 'really-simple-ssl')); ?>'); $.ajax({ url: ajaxurl, type: 'POST', data: { action: 'rsssl_resend_verification_email', rsssl_resend_email_nonce: '<?php echo wp_create_nonce('rsssl_resend_verification_email_nonce'); ?>' }, success: function(response) { if (response.success) { button.text('<?php echo esc_js(__('Email sent!', 'really-simple-ssl')); ?>'); setTimeout(function() { button.text('<?php echo esc_js(__('Resend verification email', 'really-simple-ssl')); ?>'); button.prop('disabled', false); }, 3000); } else { button.text('<?php echo esc_js(__('Failed to send', 'really-simple-ssl')); ?>'); setTimeout(function() { button.text('<?php echo esc_js(__('Resend verification email', 'really-simple-ssl')); ?>'); button.prop('disabled', false); }, 3000); } }, error: function() { button.text('<?php echo esc_js(__('Error occurred', 'really-simple-ssl')); ?>'); setTimeout(function() { button.text('<?php echo esc_js(__('Resend verification email', 'really-simple-ssl')); ?>'); button.prop('disabled', false); }, 3000); } }); }); }); </script> <?php } }
https://validator.w3.org/feed/docs/rss2.html