core.php
264 lines
| 1 | <?php // phpcs:ignore |
| 2 | |
| 3 | /** |
| 4 | * Core plugin functionality. |
| 5 | * |
| 6 | * @package WP2FA |
| 7 | */ |
| 8 | |
| 9 | namespace WP2FA\Core; |
| 10 | |
| 11 | /** |
| 12 | * Default setup routine |
| 13 | * |
| 14 | * @return void |
| 15 | */ |
| 16 | function setup() { |
| 17 | $n = function( $function ) { |
| 18 | return __NAMESPACE__ . "\\$function"; |
| 19 | }; |
| 20 | |
| 21 | add_action( 'init', $n( 'i18n' ) ); |
| 22 | add_action( 'init', $n( 'init' ) ); |
| 23 | add_action( 'admin_enqueue_scripts', $n( 'admin_scripts' ) ); |
| 24 | add_action( 'admin_enqueue_scripts', $n( 'admin_styles' ) ); |
| 25 | |
| 26 | // Hook to allow async or defer on asset loading. |
| 27 | add_filter( 'script_loader_tag', $n( 'script_loader_tag' ), 10, 2 ); |
| 28 | |
| 29 | do_action( 'wp_2fa_loaded' ); |
| 30 | } |
| 31 | |
| 32 | /** |
| 33 | * Registers the default textdomain. |
| 34 | * |
| 35 | * @return void |
| 36 | */ |
| 37 | function i18n() { |
| 38 | $locale = apply_filters( 'plugin_locale', get_locale(), 'wp-2fa' ); |
| 39 | load_textdomain( 'wp-2fa', WP_LANG_DIR . '/wp-2fa/wp-2fa-' . $locale . '.mo' ); |
| 40 | load_plugin_textdomain( 'wp-2fa', false, plugin_basename( WP_2FA_PATH ) . '/languages/' ); |
| 41 | } |
| 42 | |
| 43 | /** |
| 44 | * Initializes the plugin and fires an action other plugins can hook into. |
| 45 | * |
| 46 | * @return void |
| 47 | */ |
| 48 | function init() { |
| 49 | do_action( 'wp_2fa_init' ); |
| 50 | } |
| 51 | |
| 52 | /** |
| 53 | * Activate the plugin |
| 54 | * |
| 55 | * @return void |
| 56 | */ |
| 57 | function activate() { |
| 58 | // First load the init scripts in case any rewrite functionality is being loaded. |
| 59 | init(); |
| 60 | flush_rewrite_rules(); |
| 61 | |
| 62 | // Check if the user is allowed to manage options for the site. |
| 63 | if ( current_user_can( 'manage_options' ) ) { |
| 64 | // Add an option to let our plugin know this user has not been through the setup wizard. |
| 65 | add_option( 'wp_2fa_redirect_on_activate', true ); |
| 66 | } |
| 67 | |
| 68 | // Add plugin version to wp_options. |
| 69 | if ( \WP2FA\WP2FA::is_this_multisite() ) { |
| 70 | add_network_option( null, 'wp_2fa_plugin_version', WP_2FA_VERSION ); |
| 71 | } else { |
| 72 | add_option( 'wp_2fa_plugin_version', WP_2FA_VERSION ); |
| 73 | } |
| 74 | } |
| 75 | |
| 76 | /** |
| 77 | * Deactivate the plugin |
| 78 | * |
| 79 | * Uninstall routines should be in uninstall.php |
| 80 | * |
| 81 | * @return void |
| 82 | */ |
| 83 | function deactivate() { |
| 84 | |
| 85 | } |
| 86 | |
| 87 | /** |
| 88 | * Uninstall the plugin |
| 89 | * |
| 90 | * @return void |
| 91 | */ |
| 92 | function uninstall() { |
| 93 | if ( ! empty( \WP2FA\WP2FA::get_wp2fa_setting( 'delete_data_upon_uninstall' ) ) ) { |
| 94 | // Delete settings from wp_options. |
| 95 | if ( \WP2FA\WP2FA::is_this_multisite() ) { |
| 96 | delete_network_option( null, 'wp_2fa_settings' ); |
| 97 | delete_network_option( null, 'wp_2fa_email_settings' ); |
| 98 | delete_network_option( null, 'wp_2fa_setup_wizard_complete' ); |
| 99 | delete_network_option( null, 'wp_2fa_redirect_on_activate' ); |
| 100 | delete_network_option( null, 'wp_2fa_plugin_version' ); |
| 101 | } else { |
| 102 | delete_option( 'wp_2fa_settings' ); |
| 103 | delete_option( 'wp_2fa_email_settings' ); |
| 104 | delete_option( 'wp_2fa_setup_wizard_complete' ); |
| 105 | delete_option( 'wp_2fa_redirect_on_activate' ); |
| 106 | delete_option( 'wp_2fa_plugin_version' ); |
| 107 | } |
| 108 | |
| 109 | if ( \WP2FA\WP2FA::is_this_multisite() ) { |
| 110 | $users_args = array( 'blog_id' => 0 ); |
| 111 | } else { |
| 112 | $users_args = array(); |
| 113 | } |
| 114 | // Delete all user 2FA data. |
| 115 | $users = get_users( $users_args ); |
| 116 | foreach ( $users as $user ) { |
| 117 | delete_user_meta( $user->ID, 'wp_2fa_totp_key' ); |
| 118 | delete_user_meta( $user->ID, 'wp_2fa_backup_codes' ); |
| 119 | delete_user_meta( $user->ID, 'wp_2fa_enabled_methods' ); |
| 120 | delete_user_meta( $user->ID, 'wp_2fa_grace_period_expiry' ); |
| 121 | delete_user_meta( $user->ID, 'wp_2fa_nominated_email_address' ); |
| 122 | } |
| 123 | } |
| 124 | } |
| 125 | |
| 126 | /** |
| 127 | * The list of knows contexts for enqueuing scripts/styles. |
| 128 | * |
| 129 | * @return array |
| 130 | */ |
| 131 | function get_enqueue_contexts() { |
| 132 | return array( 'admin', 'frontend', 'shared' ); |
| 133 | } |
| 134 | |
| 135 | /** |
| 136 | * Generate an URL to a script, taking into account whether SCRIPT_DEBUG is enabled. |
| 137 | * |
| 138 | * @param string $script Script file name (no .js extension). |
| 139 | * @param string $context Context for the script ('admin', 'frontend', or 'shared'). |
| 140 | * |
| 141 | * @return string|WP_Error URL |
| 142 | */ |
| 143 | function script_url( $script, $context ) { |
| 144 | |
| 145 | if ( ! in_array( $context, get_enqueue_contexts(), true ) ) { |
| 146 | return new \WP_Error( 'invalid_enqueue_context', 'Invalid $context specified in WP2FA script loader.' ); |
| 147 | } |
| 148 | |
| 149 | return WP_2FA_URL . "dist/js/${script}.js"; |
| 150 | |
| 151 | } |
| 152 | |
| 153 | /** |
| 154 | * Generate an URL to a stylesheet, taking into account whether SCRIPT_DEBUG is enabled. |
| 155 | * |
| 156 | * @param string $stylesheet Stylesheet file name (no .css extension). |
| 157 | * @param string $context Context for the script ('admin', 'frontend', or 'shared'). |
| 158 | * |
| 159 | * @return string URL |
| 160 | */ |
| 161 | function style_url( $stylesheet, $context ) { |
| 162 | |
| 163 | if ( ! in_array( $context, get_enqueue_contexts(), true ) ) { |
| 164 | return new \WP_Error( 'invalid_enqueue_context', 'Invalid $context specified in WP2FA stylesheet loader.' ); |
| 165 | } |
| 166 | |
| 167 | return WP_2FA_URL . "dist/css/${stylesheet}.css"; |
| 168 | |
| 169 | } |
| 170 | |
| 171 | /** |
| 172 | * Enqueue scripts for admin. |
| 173 | * |
| 174 | * @return void |
| 175 | */ |
| 176 | function admin_scripts() { |
| 177 | |
| 178 | wp_enqueue_script( |
| 179 | 'wp_2fa_admin', |
| 180 | script_url( 'admin', 'admin' ), |
| 181 | array( 'jquery-ui-widget', 'jquery-ui-core', 'jquery-ui-autocomplete' ), |
| 182 | WP_2FA_VERSION, |
| 183 | true |
| 184 | ); |
| 185 | |
| 186 | wp_enqueue_script( |
| 187 | 'wp_2fa_micro_modals', |
| 188 | script_url( 'micro-modal', 'admin' ), |
| 189 | WP_2FA_VERSION, |
| 190 | true |
| 191 | ); |
| 192 | |
| 193 | // Data array. |
| 194 | $data_array = array( |
| 195 | 'ajaxURL' => admin_url( 'admin-ajax.php' ), |
| 196 | 'roles' => \WP2FA\WP2FA::wp_2fa_get_roles(), |
| 197 | 'nonce' => wp_create_nonce( 'wp-2fa-settings-nonce' ), |
| 198 | 'codeValidatedHeading' => esc_html__( 'Congratulations', 'wp-2fa' ), |
| 199 | 'codeValidatedText' => esc_html__( 'Your account just got more secure', 'wp-2fa' ), |
| 200 | 'codeValidatedButton' => esc_html__( 'Close Wizard & Refresh', 'wp-2fa' ), |
| 201 | ); |
| 202 | wp_localize_script( 'wp_2fa_admin', 'wp2faData', $data_array ); |
| 203 | |
| 204 | $data_array = array( |
| 205 | 'ajaxURL' => admin_url( 'admin-ajax.php' ), |
| 206 | 'nonce' => wp_create_nonce( 'wp2fa-verify-wizard-page' ), |
| 207 | 'codesPreamble' => esc_html__( 'These are the 2FA backup codes for the user', 'wp-2fa' ), |
| 208 | 'readyText' => esc_html__( 'I\'m ready', 'wp-2fa' ), |
| 209 | 'codeReSentText' => esc_html__( 'New code sent', 'wp-2fa' ), |
| 210 | ); |
| 211 | wp_localize_script( 'wp_2fa_admin', 'wp2faWizardData', $data_array ); |
| 212 | |
| 213 | } |
| 214 | |
| 215 | /** |
| 216 | * Enqueue styles for admin. |
| 217 | * |
| 218 | * @return void |
| 219 | */ |
| 220 | function admin_styles() { |
| 221 | |
| 222 | wp_enqueue_style( |
| 223 | 'wp_2fa_admin', |
| 224 | style_url( 'admin-style', 'admin' ), |
| 225 | array(), |
| 226 | WP_2FA_VERSION |
| 227 | ); |
| 228 | |
| 229 | } |
| 230 | |
| 231 | /** |
| 232 | * Add async/defer attributes to enqueued scripts that have the specified script_execution flag. |
| 233 | * |
| 234 | * @link https://core.trac.wordpress.org/ticket/12009 |
| 235 | * @param string $tag The script tag. |
| 236 | * @param string $handle The script handle. |
| 237 | * @return string |
| 238 | */ |
| 239 | function script_loader_tag( $tag, $handle ) { |
| 240 | $script_execution = wp_scripts()->get_data( $handle, 'script_execution' ); |
| 241 | |
| 242 | if ( ! $script_execution ) { |
| 243 | return $tag; |
| 244 | } |
| 245 | |
| 246 | if ( 'async' !== $script_execution && 'defer' !== $script_execution ) { |
| 247 | return $tag; |
| 248 | } |
| 249 | |
| 250 | // Abort adding async/defer for scripts that have this script as a dependency. _doing_it_wrong()? |
| 251 | foreach ( wp_scripts()->registered as $script ) { |
| 252 | if ( in_array( $handle, $script->deps, true ) ) { |
| 253 | return $tag; |
| 254 | } |
| 255 | } |
| 256 | |
| 257 | // Add the attribute if it hasn't already been added. |
| 258 | if ( ! preg_match( ":\s$script_execution(=|>|\s):", $tag ) ) { |
| 259 | $tag = preg_replace( ':(?=></script>):', " $script_execution", $tag, 1 ); |
| 260 | } |
| 261 | |
| 262 | return $tag; |
| 263 | } |
| 264 |