enmi-conf.org: wp/wp-includes/class-wp-user-meta-session-tokens.php@177826044cd9 (annotated)

7 cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	1	<?php
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	2	/**
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	3	* Session API: WP_User_Meta_Session_Tokens class
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	4	*
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	5	* @package WordPress
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	6	* @subpackage Session
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	7	* @since 4.7.0
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	8	*/
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	9
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	10	/**
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	11	* Meta-based user sessions token manager.
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	12	*
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	13	* @since 4.0.0
9 177826044cd9 upgrade wordpress to 5.2.3 ymh <ymh.work@gmail.com> parents: 7 diff changeset	14	*
177826044cd9 upgrade wordpress to 5.2.3 ymh <ymh.work@gmail.com> parents: 7 diff changeset	15	* @see WP_Session_Tokens
7 cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	16	*/
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	17	class WP_User_Meta_Session_Tokens extends WP_Session_Tokens {
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	18
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	19	/**
9 177826044cd9 upgrade wordpress to 5.2.3 ymh <ymh.work@gmail.com> parents: 7 diff changeset	20	* Retrieves all sessions of the user.
7 cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	21	*
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	22	* @since 4.0.0
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	23	*
9 177826044cd9 upgrade wordpress to 5.2.3 ymh <ymh.work@gmail.com> parents: 7 diff changeset	24	* @return array Sessions of the user.
7 cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	25	*/
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	26	protected function get_sessions() {
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	27	$sessions = get_user_meta( $this->user_id, 'session_tokens', true );
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	28
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	29	if ( ! is_array( $sessions ) ) {
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	30	return array();
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	31	}
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	32
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	33	$sessions = array_map( array( $this, 'prepare_session' ), $sessions );
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	34	return array_filter( $sessions, array( $this, 'is_still_valid' ) );
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	35	}
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	36
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	37	/**
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	38	* Converts an expiration to an array of session information.
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	39	*
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	40	* @param mixed $session Session or expiration.
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	41	* @return array Session.
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	42	*/
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	43	protected function prepare_session( $session ) {
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	44	if ( is_int( $session ) ) {
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	45	return array( 'expiration' => $session );
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	46	}
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	47
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	48	return $session;
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	49	}
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	50
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	51	/**
9 177826044cd9 upgrade wordpress to 5.2.3 ymh <ymh.work@gmail.com> parents: 7 diff changeset	52	* Retrieves a session based on its verifier (token hash).
7 cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	53	*
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	54	* @since 4.0.0
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	55	*
9 177826044cd9 upgrade wordpress to 5.2.3 ymh <ymh.work@gmail.com> parents: 7 diff changeset	56	* @param string $verifier Verifier for the session to retrieve.
7 cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	57	* @return array\|null The session, or null if it does not exist
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	58	*/
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	59	protected function get_session( $verifier ) {
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	60	$sessions = $this->get_sessions();
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	61
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	62	if ( isset( $sessions[ $verifier ] ) ) {
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	63	return $sessions[ $verifier ];
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	64	}
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	65
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	66	return null;
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	67	}
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	68
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	69	/**
9 177826044cd9 upgrade wordpress to 5.2.3 ymh <ymh.work@gmail.com> parents: 7 diff changeset	70	* Updates a session based on its verifier (token hash).
7 cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	71	*
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	72	* @since 4.0.0
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	73	*
9 177826044cd9 upgrade wordpress to 5.2.3 ymh <ymh.work@gmail.com> parents: 7 diff changeset	74	* @param string $verifier Verifier for the session to update.
7 cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	75	* @param array $session Optional. Session. Omitting this argument destroys the session.
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	76	*/
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	77	protected function update_session( $verifier, $session = null ) {
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	78	$sessions = $this->get_sessions();
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	79
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	80	if ( $session ) {
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	81	$sessions[ $verifier ] = $session;
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	82	} else {
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	83	unset( $sessions[ $verifier ] );
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	84	}
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	85
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	86	$this->update_sessions( $sessions );
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	87	}
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	88
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	89	/**
9 177826044cd9 upgrade wordpress to 5.2.3 ymh <ymh.work@gmail.com> parents: 7 diff changeset	90	* Updates the user's sessions in the usermeta table.
7 cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	91	*
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	92	* @since 4.0.0
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	93	*
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	94	* @param array $sessions Sessions.
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	95	*/
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	96	protected function update_sessions( $sessions ) {
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	97	if ( $sessions ) {
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	98	update_user_meta( $this->user_id, 'session_tokens', $sessions );
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	99	} else {
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	100	delete_user_meta( $this->user_id, 'session_tokens' );
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	101	}
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	102	}
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	103
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	104	/**
9 177826044cd9 upgrade wordpress to 5.2.3 ymh <ymh.work@gmail.com> parents: 7 diff changeset	105	* Destroys all sessions for this user, except the single session with the given verifier.
7 cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	106	*
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	107	* @since 4.0.0
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	108	*
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	109	* @param string $verifier Verifier of the session to keep.
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	110	*/
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	111	protected function destroy_other_sessions( $verifier ) {
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	112	$session = $this->get_session( $verifier );
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	113	$this->update_sessions( array( $verifier => $session ) );
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	114	}
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	115
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	116	/**
9 177826044cd9 upgrade wordpress to 5.2.3 ymh <ymh.work@gmail.com> parents: 7 diff changeset	117	* Destroys all session tokens for the user.
7 cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	118	*
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	119	* @since 4.0.0
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	120	*/
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	121	protected function destroy_all_sessions() {
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	122	$this->update_sessions( array() );
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	123	}
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	124
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	125	/**
9 177826044cd9 upgrade wordpress to 5.2.3 ymh <ymh.work@gmail.com> parents: 7 diff changeset	126	* Destroys all sessions for all users.
7 cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	127	*
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	128	* @since 4.0.0
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	129	*/
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	130	public static function drop_sessions() {
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	131	delete_metadata( 'user', 0, 'session_tokens', false, true );
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	132	}
cf61fcea0001 resynchronize code repo with production ymh <ymh.work@gmail.com> parents: diff changeset	133	}

author	ymh <ymh.work@gmail.com>
	Mon, 14 Oct 2019 18:28:13 +0200
changeset 9	177826044cd9
parent 7	cf61fcea0001
permissions	-rw-r--r--