# magic-login/2.1/includes/utils.php Magic Login – Magic Link & Passwordless Authentication for WordPress – Login Without Password, version 2.1. 372 lines. - Page: https://pluginprobe.com/plugins/magic-login/2.1/code/includes/utils.php - Raw: https://pluginprobe.com/plugins/magic-login/2.1/raw/includes/utils.php - Modified: 2024-02-13T11:06:20+00:00 Line numbers below start at 1. Link to a line or a range by appending a fragment to the page URL, for example `https://pluginprobe.com/plugins/magic-login/2.1/code/includes/utils.php#L10-L20`. ```php ID, TOKEN_USER_META, true ); $tokens = is_string( $tokens ) ? array( $tokens ) : $tokens; $new_token = sha1( wp_generate_password() ); $hashed_token = hash_hmac( 'sha256', $new_token, wp_salt() ); $ip = sha1( get_client_ip() ); if ( defined( 'WP_CLI' ) && WP_CLI ) { $ip = 'cli'; } $tokens[] = [ 'token' => $hashed_token, 'time' => time(), 'ip_hash' => $ip, ]; update_user_meta( $user->ID, TOKEN_USER_META, $tokens ); if ( absint( $settings['token_ttl'] ) > 0 ) { // eternal token wp_schedule_single_event( time() + ( $settings['token_ttl'] * MINUTE_IN_SECONDS ), CRON_HOOK_NAME, array( $user->ID ) ); } return $new_token; } /** * Create login link for given user * * @param object $user WP_User object * * @return mixed|string */ function create_login_link( $user ) { $token = create_user_token( $user ); $query_args = array( 'user_id' => $user->ID, 'token' => $token, 'magic-login' => 1, ); if ( ! empty( $_POST['redirect_to'] ) ) { $query_args['redirect_to'] = urlencode( wp_unslash( $_POST['redirect_to'] ) ); // phpcs:ignore } $login_url = esc_url_raw( add_query_arg( $query_args, wp_login_url() ) ); return $login_url; } /** * Get client raw ip * this should be hashed * * @return mixed */ function get_client_ip() { /** * `HTTP_X_FORWARDED_FOR` removed in 1.5 * Filters the ip address * * @hook magic_login_client_ip * * @param {string} REMOTE_ADDR * * @return {string} New value. * @since 1.5 */ return apply_filters( 'magic_login_client_ip', $_SERVER['REMOTE_ADDR'] ); // phpcs:ignore } /** * Get settings with defaults * * @return array * @since 1.0 */ function get_settings() { $defaults = [ 'is_default' => false, 'add_login_button' => true, 'token_ttl' => 5, 'token_validity' => 1, 'token_interval' => 'MINUTE', 'enable_brute_force_protection' => false, 'brute_force_bantime' => 60, // in minutes 'brute_force_login_attempt' => 10, 'brute_force_login_time' => 5, // in minutes 'enable_login_throttling' => false, 'login_throttling_limit' => 10, 'login_throttling_time' => 15, // in minutes 'enable_ip_check' => false, 'enable_domain_restriction' => false, 'allowed_domains' => '', 'login_email' => get_default_login_email_text(), 'enable_login_redirection' => false, 'default_redirection_url' => '', 'enforce_redirection_rules' => true, 'enable_wp_login_redirection' => false, 'enable_role_based_redirection' => false, 'role_based_redirection_rules' => [], 'email_subject' => __( 'Log in to {{SITENAME}}', 'magic-login' ), 'auto_login_links' => false, 'enable_ajax' => false, 'enable_woo_integration' => false, 'woo_position' => 'before', ]; if ( MAGIC_LOGIN_IS_NETWORK ) { $settings = get_site_option( SETTING_OPTION, [] ); } else { $settings = get_option( SETTING_OPTION, [] ); } $settings = wp_parse_args( $settings, $defaults ); return $settings; } /** * Default login email message * * @return mixed|string|void */ function get_default_login_email_text() { /* translators: Do not translate USERNAME, SITENAME,EXPIRES, MAGIC_LINK, SITENAME, SITEUR, EXPIRES_WITH_INTERVAL: those are placeholders. */ $email_text = __( 'Hi {{USERNAME}}, Click and confirm that you want to log in to {{SITENAME}}. This link will expire in {{EXPIRES_WITH_INTERVAL}} and can only be used once: Log In Need the link? {{MAGIC_LINK}} You can safely ignore and delete this email if you do not want to log in. Regards, All at {{SITENAME}} {{SITEURL}}', 'magic-login' ); return $email_text; } /** * Is plugin activated network wide? * * @param string $plugin_file file path * * @return bool * @since 1.0 */ function is_network_wide( $plugin_file ) { if ( ! is_multisite() ) { return false; } if ( ! function_exists( 'is_plugin_active_for_network' ) ) { require_once ABSPATH . '/wp-admin/includes/plugin.php'; } return is_plugin_active_for_network( plugin_basename( $plugin_file ) ); } /** * Get login link * * @return mixed|string */ function get_magic_login_url() { return esc_url_raw( site_url( 'wp-login.php?action=magic_login', 'login_post' ) ); } /** * Get user tokens * * @param int $user_id User ID * @param bool $clear_expired flag for clean-up expired tokens * * @return array|mixed */ function get_user_tokens( $user_id, $clear_expired = false ) { $tokens = get_user_meta( $user_id, TOKEN_USER_META, true ); $tokens = is_array( $tokens ) ? $tokens : []; /** * Filter user tokens * * @hook magic_login_user_tokens * * @param {array} $tokens User tokens. * @param {int} $user_id User ID. * @param {boolean} $clear_expired Whether to clear expired tokens or not. * * @return {array} New value * @since 2.1 */ $tokens = (array) apply_filters( 'magic_login_user_tokens', $tokens, $user_id, $clear_expired ); if ( $clear_expired ) { $settings = get_settings(); //phpcs:ignore $ttl = absint( $settings['token_ttl'] ); if ( 0 === $ttl ) { // means token lives forever till used return $tokens; } foreach ( $tokens as $index => $token_data ) { if ( empty( $token_data ) ) { unset( $tokens[ $index ] ); continue; } if ( time() > absint( $token_data['time'] ) + ( $ttl * MINUTE_IN_SECONDS ) ) { unset( $tokens[ $index ] ); } } update_user_meta( $user_id, TOKEN_USER_META, $tokens ); } return $tokens; } /** * Get default redirect url for given user * * @param \WP_User $user User object * * @return string|void */ function get_user_default_redirect( $user ) { if ( is_multisite() && ! get_active_blog_for_user( $user->ID ) && ! is_super_admin( $user->ID ) ) { $redirect_to = user_admin_url(); } elseif ( is_multisite() && ! $user->has_cap( 'read' ) ) { $redirect_to = get_dashboard_url( $user->ID ); } elseif ( ! $user->has_cap( 'edit_posts' ) ) { $redirect_to = $user->has_cap( 'read' ) ? admin_url( 'profile.php' ) : home_url(); } else { $redirect_to = admin_url(); } return $redirect_to; } /** * Delete all token meta */ function delete_all_tokens() { global $wpdb; return $wpdb->delete( // phpcs:ignore WordPress.DB.DirectDatabaseQuery.NoCaching,WordPress.DB.DirectDatabaseQuery.DirectQuery $wpdb->usermeta, [ 'meta_key' => TOKEN_USER_META, // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key ] ); } /** * Allowed intervals for TTL. * * @return array * @since 1.2 */ function get_allowed_intervals() { return [ 'MINUTE' => esc_html__( 'Minute(s)', 'magic-login' ), 'HOUR' => esc_html__( 'Hour(s)', 'magic-login' ), 'DAY' => esc_html__( 'Day(s)', 'magic-login' ), ]; } /** * Convert minutes to possible time format * * @param int $timeout_in_minutes TTL in minutes * * @return array * @since 1.2 */ function get_ttl_with_interval( $timeout_in_minutes ) { $ttl = $timeout_in_minutes; $interval = 'MINUTE'; if ( $ttl > 0 ) { if ( 0 === (int) ( $ttl % 1440 ) ) { $ttl = $ttl / 1440; $interval = 'DAY'; } elseif ( 0 === (int) ( $ttl % 60 ) ) { $ttl = $ttl / 60; $interval = 'HOUR'; } } return array( $ttl, $interval, ); } /** * Get the documentation url * * @param string $path The path of documentation * @param string $fragment URL Fragment * * @return string final URL */ function get_doc_url( $path = null, $fragment = '' ) { $doc_base = 'https://handyplugins.co/magic-login-pro/docs/'; $utm_parameters = '?utm_source=wp_admin&utm_medium=plugin&utm_campaign=settings_page'; if ( ! empty( $path ) ) { $doc_base .= ltrim( $path, '/' ); } $doc_url = trailingslashit( $doc_base ) . $utm_parameters; if ( ! empty( $fragment ) ) { $doc_url .= '#' . $fragment; } return $doc_url; } /** * Check weather current screen is magic login settings page or not * * @return bool * @since 1.2.1 */ function is_magic_login_settings_screen() { $current_screen = get_current_screen(); if ( ! is_a( $current_screen, '\WP_Screen' ) ) { return false; } if ( false !== strpos( $current_screen->base, 'magic-login' ) ) { return true; } return false; } ```