Source: classes/Authentication.php

  1. <?php
  2. /**
  3.  * Authentication base class
  4.  *
  5.  * @package  distributor
  6.  */
  8. namespace Distributor;
  10. use \Distributor\ExternalConnection as ExternalConnection;
  12. /**
  13.  * Authentication types extend this base abstract class. Authentication types
  14.  * are used to authenticate push and pull requests for an external connection. Note that static
  15.  * methods are used for interacting with the type whereas class instances deal with
  16.  * an actual external connection.
  17.  */
  18. abstract class Authentication {
  20. 	/**
  21. 	 * Error message
  22. 	 *
  23. 	 * @var string
  24. 	 */
  25. 	public static $error_message;
  27. 	/**
  28. 	 * Set associative arguments as instance variables
  29. 	 *
  30. 	 * @param array $args Array of arguments to set.
  31. 	 * @since       0.8
  32. 	 */
  33. 	public function __construct( $args ) {
  34. 		if ( ! empty( $args ) ) {
  35. 			foreach ( $args as $key => $value ) {
  36. 				$this->$key = $value;
  37. 			}
  38. 		}
  39. 	}
  41. 	/**
  42. 	 * Format request args for a GET request so auth occurs
  43. 	 *
  44. 	 * @param  array $args Arguments to format.
  45. 	 * @param  array $context optional array of information about the request
  46. 	 * @since  0.8
  47. 	 * @return array
  48. 	 */
  49. 	public function format_get_args( $args = array(), $context = array() ) {
  50. 		if ( ! isset( $args['headers'] ) ) {
  51. 			$args['headers'] = array();
  52. 		}
  53. 		$args['headers']['X-Distributor-Version'] = DT_VERSION;
  55. 		/**
  56. 		 * Format request args for a GET request so auth occurs.
  57. 		 *
  58. 		 * @since 0.8
  59. 		 * @hook dt_auth_format_get_args
  60. 		 *
  61. 		 * @param  {array}  $args    Array of request arguments.
  62. 		 * @param  {array}  $context Optional array of information about the request.
  63. 		 * @param  {object} $this    The authentication class.
  64. 		 *
  65. 		 * @return {array} Array of request arguments.
  66. 		 */
  67. 		return apply_filters( 'dt_auth_format_get_args', $args, $context, $this );
  68. 	}
  70. 	/**
  71. 	 * Format request args for a POST request so auth occurs
  72. 	 *
  73. 	 * @param  array $args Arguments to format.
  74. 	 * @param  array $context optional array of information about the request
  75. 	 * @since  0.8
  76. 	 * @return array
  77. 	 */
  78. 	public function format_post_args( $args, $context = array() ) {
  79. 		if ( ! isset( $args['headers'] ) ) {
  80. 			$args['headers'] = array();
  81. 		}
  82. 		$args['headers']['X-Distributor-Version'] = DT_VERSION;
  84. 		/**
  85. 		 * Format request args for a POST request so auth occurs
  86. 		 *
  87. 		 * @since 0.8
  88. 		 * @hook dt_auth_format_post_args
  89. 		 *
  90. 		 * @param  {array}  $args    Array of request arguments.
  91. 		 * @param  {array}  $context Optional array of information about the request.
  92. 		 * @param  {object} $this    The authentication class.
  93. 		 *
  94. 		 * @return {array} Array of request arguments.
  95. 		 */
  96. 		return apply_filters( 'dt_auth_format_post_args', $args, $context, $this );
  97. 	}
  99. 	/**
  100. 	 * Output a credentials form in the external connection management screen.
  101. 	 *
  102. 	 * Child classes should implement - public static function credentials_form();
  103. 	 */
  105. 	/**
  106. 	 * Store an associate array as credentials for use with an external connection.
  107. 	 *
  108. 	 * Child classes should implement - public static function prepare_credentials( $args );
  109. 	 */
  111. 	/**
  112. 	 * Store pre-sanizited auth credentials in DB
  113. 	 *
  114. 	 * @param int   $external_connection_id External connection ID.
  115. 	 * @param array $args Array of credentials to store. Should be pre-sanitized.
  116. 	 * @since 0.8
  117. 	 */
  118. 	public static function store_credentials( $external_connection_id, $args ) {
  119. 		update_post_meta( $external_connection_id, 'dt_external_connection_auth', $args );
  120. 	}
  122. 	/**
  123. 	 * Oauth connection error logging facility for non production environments.
  124. 	 *
  125. 	 * @param string $error_message The error message to log.
  126. 	 */
  127. 	public static function log_authentication_error( $error_message ) {
  129. 		// Store the message for output at the top of the authorization form
  130. 		self::$error_message = $error_message;
  131. 		add_action(
  132. 			'auth_admin_notices',
  133. 			function() {
  134. 				?>
  135. 		<div class="notice notice-error is-dismissible">
  136. 			<p>
  137. 				<strong>
  138. 					<?php esc_html_e( 'Authorization error:', 'distributor' ); ?>
  139. 				</strong> <?php echo esc_html( self::$error_message ); ?>
  140. 			</p>
  141. 		</div>
  142. 				<?php
  143. 			}
  144. 		);
  145. 		if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
  146. 			$time = gmdate( '[d/M/Y:H:i:s]' );
  147. 			// @codingStandardsIgnoreLine - error_log is only used when WP_DEBUG is true.
  148. 			error_log( $time . ': ' . $error_message );
  149. 		}
  150. 	}
  151. }