class-wp-user-meta-session-tokens.php 2.8 KB

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