WordPressを読む 33 /blog/wp-includes/session.php
2014/12/17
目次
- 1 /blog/wp-includes/session.php
- 2 WP_Session_Tokens::クラス変数
- 3 WP_Session_Tokens::__construct() コンストラクタ
- 4 WP_Session_Tokens::get_instance()
- 5 WP_Session_Tokens::hash_token()
- 6 WP_Session_Tokens::get()
- 7 WP_Session_Tokens::verify()
- 8 WP_Session_Tokens::create()
- 9 WP_Session_Tokens::update()
- 10 WP_Session_Tokens::destroy()
- 11 WP_Session_Tokens::destroy_others()
- 12 WP_Session_Tokens::is_still_valid()
- 13 WP_Session_Tokens::destroy_all()
- 14 WP_Session_Tokens::destroy_all_for_all_users()
- 15 WP_Session_Tokens::get_all()
- 16 WP_Session_Tokens::get_sessions()
- 17 WP_Session_Tokens::get_session()
- 18 WP_Session_Tokens::update_session()
- 19 WP_Session_Tokens::destroy_other_sessions()
- 20 WP_Session_Tokens::destroy_all_sessions()
- 21 WP_Session_Tokens::drop_sessions()
- 22 WP_User_Meta_Session_Tokens::get_sessions()
- 23 WP_User_Meta_Session_Tokens::prepare_session()
- 24 WP_User_Meta_Session_Tokens::get_session()
- 25 WP_User_Meta_Session_Tokens::update_session()
- 26 WP_User_Meta_Session_Tokens::update_sessions()
- 27 WP_User_Meta_Session_Tokens::destroy_other_sessions()
- 28 WP_User_Meta_Session_Tokens::destroy_all_sessions()
- 29 WP_User_Meta_Session_Tokens::drop_sessions()
/blog/wp-includes/session.php
WP_Session_Tokens::クラス変数
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | <?php /** * Abstract class for managing user session tokens. * * @since 4.0.0 */ abstract class WP_Session_Tokens { /** * User ID. * * @since 4.0.0 * @access protected * @var int User ID. */ protected $user_id; |
WP_Session_Tokens::__construct() コンストラクタ
1 2 3 4 5 6 7 8 9 10 | /** * Protected constructor. * * @since 4.0.0 * * @param int $user_id User whose session to manage. */ protected function __construct( $user_id ) { $this->user_id = $user_id; } |
WP_Session_Tokens::get_instance()
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | /** * Get a session token manager instance for a user. * * This method contains a filter that allows a plugin to swap out * the session manager for a subclass of WP_Session_Tokens. * * @since 4.0.0 * @access public * @static * * @param int $user_id User whose session to manage. */ final public static function get_instance( $user_id ) { /** * Filter the session token manager used. * * @since 4.0.0 * * @param string $session Name of class to use as the manager. * Default 'WP_User_Meta_Session_Tokens'. */ $manager = apply_filters( 'session_token_manager', 'WP_User_Meta_Session_Tokens' ); return new $manager( $user_id ); } |
WP_Session_Tokens::hash_token()
1 2 3 4 5 6 7 8 9 10 11 12 | /** * Hashes a session token for storage. * * @since 4.0.0 * @access private * * @param string $token Session token to hash. * @return string A hash of the session token (a verifier). */ final private function hash_token( $token ) { return hash( 'sha256', $token ); } |
WP_Session_Tokens::get()
1 2 3 4 5 6 7 8 9 10 11 12 13 | /** * Get a user's session. * * @since 4.0.0 * @access public * * @param string $token Session token * @return array User session */ final public function get( $token ) { $verifier = $this->hash_token( $token ); return $this->get_session( $verifier ); } |
WP_Session_Tokens::verify()
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | /** * Validate a user's session token as authentic. * * Checks that the given token is present and hasn't expired. * * @since 4.0.0 * @access public * * @param string $token Token to verify. * @return bool Whether the token is valid for the user. */ final public function verify( $token ) { $verifier = $this->hash_token( $token ); return (bool) $this->get_session( $verifier ); } |
WP_Session_Tokens::create()
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | /** * Generate a session token and attach session information to it. * * A session token is a long, random string. It is used in a cookie * link that cookie to an expiration time and to ensure the cookie * becomes invalidated upon logout. * * This function generates a token and stores it with the associated * expiration time (and potentially other session information via the * `attach_session_information` filter). * * @since 4.0.0 * @access public * * @param int $expiration Session expiration timestamp. * @return string Session token. */ final public function create( $expiration ) { /** * Filter the information attached to the newly created session. * * Could be used in the future to attach information such as * IP address or user agent to a session. * * @since 4.0.0 * * @param array $session Array of extra data. * @param int $user_id User ID. */ $session = apply_filters( 'attach_session_information', array(), $this->user_id ); $session['expiration'] = $expiration; $token = wp_generate_password( 43, false, false ); $this->update( $token, $session ); return $token; } |
WP_Session_Tokens::update()
1 2 3 4 5 6 7 8 9 10 11 12 13 | /** * Update a session token. * * @since 4.0.0 * @access public * * @param string $token Session token to update. * @param array $session Session information. */ final public function update( $token, $session ) { $verifier = $this->hash_token( $token ); $this->update_session( $verifier, $session ); } |
WP_Session_Tokens::destroy()
1 2 3 4 5 6 7 8 9 10 11 12 | /** * Destroy a session token. * * @since 4.0.0 * @access public * * @param string $token Session token to destroy. */ final public function destroy( $token ) { $verifier = $this->hash_token( $token ); $this->update_session( $verifier, null ); } |
WP_Session_Tokens::destroy_others()
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | /** * Destroy all session tokens for this user, * except a single token, presumably the one in use. * * @since 4.0.0 * @access public * * @param string $token_to_keep Session token to keep. */ final public function destroy_others( $token_to_keep ) { $verifier = $this->hash_token( $token_to_keep ); $session = $this->get_session( $verifier ); if ( $session ) { $this->destroy_other_sessions( $verifier ); } else { $this->destroy_all_sessions(); } } |
WP_Session_Tokens::is_still_valid()
1 2 3 4 5 6 7 8 9 10 11 12 13 | /** * Determine whether a session token is still valid, * based on expiration. * * @since 4.0.0 * @access protected * * @param array $session Session to check. * @return bool Whether session is valid. */ final protected function is_still_valid( $session ) { return $session['expiration'] >= time(); } |
WP_Session_Tokens::destroy_all()
1 2 3 4 5 6 7 8 9 | /** * Destroy all session tokens for a user. * * @since 4.0.0 * @access public */ final public function destroy_all() { $this->destroy_all_sessions(); } |
WP_Session_Tokens::destroy_all_for_all_users()
1 2 3 4 5 6 7 8 9 10 11 | /** * Destroy all session tokens for all users. * * @since 4.0.0 * @access public * @static */ final public static function destroy_all_for_all_users() { $manager = apply_filters( 'session_token_manager', 'WP_User_Meta_Session_Tokens' ); call_user_func( array( $manager, 'drop_sessions' ) ); } |
WP_Session_Tokens::get_all()
1 2 3 4 5 6 7 8 9 10 11 | /** * Retrieve all sessions of a user. * * @since 4.0.0 * @access public * * @return array Sessions of a user. */ final public function get_all() { return array_values( $this->get_sessions() ); } |
WP_Session_Tokens::get_sessions()
1 2 3 4 5 6 7 8 9 | /** * This method should retrieve all sessions of a user, keyed by verifier. * * @since 4.0.0 * @access protected * * @return array Sessions of a user, keyed by verifier. */ abstract protected function get_sessions(); |
WP_Session_Tokens::get_session()
1 2 3 4 5 6 7 8 9 10 | /** * This method should look up a session by its verifier (token hash). * * @since 4.0.0 * @access protected * * @param string $verifier Verifier of the session to retrieve. * @return array|null The session, or null if it does not exist. */ abstract protected function get_session( $verifier ); |
WP_Session_Tokens::update_session()
1 2 3 4 5 6 7 8 9 10 11 | /** * This method should update a session by its verifier. * * Omitting the second argument should destroy the session. * * @since 4.0.0 * @access protected * * @param string $verifier Verifier of the session to update. */ abstract protected function update_session( $verifier, $session = null ); |
WP_Session_Tokens::destroy_other_sessions()
1 2 3 4 5 6 7 8 9 10 | /** * This method should destroy all session tokens for this user, * except a single session passed. * * @since 4.0.0 * @access protected * * @param string $verifier Verifier of the session to keep. */ abstract protected function destroy_other_sessions( $verifier ); |
WP_Session_Tokens::destroy_all_sessions()
1 2 3 4 5 6 7 | /** * This method should destroy all sessions for a user. * * @since 4.0.0 * @access protected */ abstract protected function destroy_all_sessions(); |
WP_Session_Tokens::drop_sessions()
1 2 3 4 5 6 7 8 9 | /** * This static method should destroy all session tokens for all users. * * @since 4.0.0 * @access public * @static */ public static function drop_sessions() {} } |
WP_Session_Tokens::クラス終了
WP_User_Meta_Session_Tokens::
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | /** * Meta-based user sessions token manager. * * @since 4.0.0 */ class WP_User_Meta_Session_Tokens extends WP_Session_Tokens { /** * Get all sessions of a user. * * @since 4.0.0 * @access protected * * @return array Sessions of a user. */ |
抽象クラスWP_Session_Tokens の実装
WP_User_Meta_Session_Tokens::get_sessions()
1 2 3 4 5 6 7 8 9 10 | protected function get_sessions() { $sessions = get_user_meta( $this->user_id, 'session_tokens', true ); if ( ! is_array( $sessions ) ) { return array(); } $sessions = array_map( array( $this, 'prepare_session' ), $sessions ); return array_filter( $sessions, array( $this, 'is_still_valid' ) ); } |
WP_User_Meta_Session_Tokens::prepare_session()
1 2 3 4 5 6 7 8 9 10 11 12 13 | /** * Converts an expiration to an array of session information. * * @param mixed $session Session or expiration. * @return array Session. */ protected function prepare_session( $session ) { if ( is_int( $session ) ) { return array( 'expiration' => $session ); } return $session; } |
WP_User_Meta_Session_Tokens::get_session()
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | /** * Retrieve a session by its verifier (token hash). * * @since 4.0.0 * @access protected * * @param string $verifier Verifier of the session to retrieve. * @return array|null The session, or null if it does not exist */ protected function get_session( $verifier ) { $sessions = $this->get_sessions(); if ( isset( $sessions[ $verifier ] ) ) { return $sessions[ $verifier ]; } return null; } |
WP_User_Meta_Session_Tokens::update_session()
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | /** * Update a session by its verifier. * * @since 4.0.0 * @access protected * * @param string $verifier Verifier of the session to update. * @param array $session Optional. Session. Omitting this argument destroys the session. */ protected function update_session( $verifier, $session = null ) { $sessions = $this->get_sessions(); if ( $session ) { $sessions[ $verifier ] = $session; } else { unset( $sessions[ $verifier ] ); } $this->update_sessions( $sessions ); } |
WP_User_Meta_Session_Tokens::update_sessions()
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | /** * Update a user's sessions in the usermeta table. * * @since 4.0.0 * @access protected * * @param array $sessions Sessions. */ protected function update_sessions( $sessions ) { if ( ! has_filter( 'attach_session_information' ) ) { $sessions = wp_list_pluck( $sessions, 'expiration' ); } if ( $sessions ) { update_user_meta( $this->user_id, 'session_tokens', $sessions ); } else { delete_user_meta( $this->user_id, 'session_tokens' ); } } |
WP_User_Meta_Session_Tokens::destroy_other_sessions()
1 2 3 4 5 6 7 8 9 10 11 12 | /** * Destroy all session tokens for a user, except a single session passed. * * @since 4.0.0 * @access protected * * @param string $verifier Verifier of the session to keep. */ protected function destroy_other_sessions( $verifier ) { $session = $this->get_session( $verifier ); $this->update_sessions( array( $verifier => $session ) ); } |
WP_User_Meta_Session_Tokens::destroy_all_sessions()
1 2 3 4 5 6 7 8 9 | /** * Destroy all session tokens for a user. * * @since 4.0.0 * @access protected */ protected function destroy_all_sessions() { $this->update_sessions( array() ); } |
WP_User_Meta_Session_Tokens::drop_sessions()
1 2 3 4 5 6 7 8 9 10 11 | /** * Destroy all session tokens for all users. * * @since 4.0.0 * @access public * @static */ public static function drop_sessions() { delete_metadata( 'user', false, 'session_tokens', false, true ); } } |
WP_User_Meta_Session_Tokens::クラス定義終了