Fix mcrypt fatal - Removed on PHP 7.2

includes/class-syndication-encryption.php

@@ -1,9 +1,5 @@
 <?php
 
-require_once dirname( __FILE__ ) . '/class-syndication-encryptor.php';
-require_once dirname( __FILE__ ) . '/class-syndication-encryptor-openssl.php';
-require_once dirname( __FILE__ ) . '/class-syndication-encryptor-mcrypt.php';
-
 /**
  * Class Syndication_Encryption
  */
@@ -19,22 +15,30 @@ class Syndication_Encryption {
 	/**
 	 * Returns the best possible Encryptor, given the current environment.
 	 *
-	 * @return Syndication_Encryptor
+	 * @return Syndication_Encryptor|false
 	 */
 	public static function get_encryptor() {
 		if ( isset( self::$encryptor ) && self::$encryptor instanceof Syndication_Encryptor ) {
 			return self::$encryptor;
 		}
 
-		// On PHP 7.1 mcrypt is available, but will throw a deprecated error if its used. Therefore, checking for the
-		// PHP version, instead of checking for mcrypt is a better approach.
-		if ( version_compare( PHP_VERSION, '7.1', '<' ) ) {
-			self::$encryptor = new Syndication_Encryptor_MCrypt();
+		return false;
+	}
+
+	/**
+	 * Set the Encryptor that will be used for the encryption and decryption operations.
+	 *
+	 * @param Syndication_Encryptor $encryptor Encryptor to be used in the encryption.
+	 *
+	 * @return Syndication_Encryptor|false Returns the encryptor
+	 */
+	public static function set_encryptor( $encryptor ) {
+		if ( $encryptor instanceof Syndication_Encryptor ) {
+			self::$encryptor = $encryptor;
 			return self::$encryptor;
 		}
 
-		self::$encryptor = new Syndication_Encryptor_OpenSSL();
-		return self::$encryptor;
+		return false;
 	}
 
 	/**

includes/class-syndication-encryptor-mcrypt.php

@@ -1,11 +1,9 @@
 <?php
 
-require_once dirname( __FILE__ ) . '/class-syndication-encryptor.php';
-
 /**
  * Class Syndication_Encryptor_OpenSSL
  */
-class Syndication_Encryptor_MCrypt extends Syndication_Encryptor {
+class Syndication_Encryptor_MCrypt implements Syndication_Encryptor {
 
 	/**
 	 * @inheritDoc
@@ -32,7 +30,7 @@ public function decrypt( $data, $associative = true ) {
 	/**
 	 * @inheritDoc
 	 */
-	public function getCipher() {
+	public function get_cipher() {
 		return MCRYPT_RIJNDAEL_256; // phpcs:ignore PHPCompatibility.Constants.RemovedConstants.mcrypt_rijndael_256DeprecatedRemoved
 	}
 }

includes/class-syndication-encryptor-openssl.php

@@ -1,11 +1,9 @@
 <?php
 
-require_once dirname( __FILE__ ) . '/class-syndication-encryptor.php';
-
 /**
  * Class Syndication_Encryptor_OpenSSL
  */
-class Syndication_Encryptor_OpenSSL extends Syndication_Encryptor {
+class Syndication_Encryptor_OpenSSL implements Syndication_Encryptor {
 
 	/**
 	 * The cipher to be used for encryption.
@@ -19,7 +17,7 @@ class Syndication_Encryptor_OpenSSL extends Syndication_Encryptor {
 	 */
 	public function encrypt( $data ) {
 		$data   = wp_json_encode( $data );
-		$cipher = $this->getCipher();
+		$cipher = $this->get_cipher();
 
 		if ( ! $cipher ) {
 			return $data;
@@ -33,7 +31,7 @@ public function encrypt( $data ) {
 	 * @inheritDoc
 	 */
 	public function decrypt( $data, $associative = true ) {
-		$cipher = $this->getCipher();
+		$cipher = $this->get_cipher();
 
 		if ( ! $cipher ) {
 			return $data;
@@ -51,7 +49,7 @@ public function decrypt( $data, $associative = true ) {
 	/**
 	 * @inheritDoc
 	 */
-	public function getCipher() {
+	public function get_cipher() {
 		if ( in_array( $this->cipher, openssl_get_cipher_methods(), true ) ) {
 			return array(
 				'cipher' => $this->cipher,

includes/interface-syndication-encryptor.php

@@ -0,0 +1,33 @@
+<?php
+
+/**
+ * Interface Syndication_Encryptor
+ */
+interface Syndication_Encryptor {
+
+	/**
+	 * Encrypts data.
+	 *
+	 * @param string|array $data Data to be encrypted.
+	 *
+	 * @return string
+	 */
+	public function encrypt( $data );
+
+	/**
+	 * Decrypts data
+	 *
+	 * @param string $data        Data to be decrypted.
+	 * @param bool   $associative If true, returns as an associative array. Otherwise returns as a class.
+	 *
+	 * @return mixed
+	 */
+	public function decrypt( $data, $associative = true );
+
+	/**
+	 * Returns the cipher being used. It can be a string, or a array with the cipher, key and iv.
+	 *
+	 * @return string|array
+	 */
+	public function get_cipher();
+}

push-syndication.php

@@ -11,21 +11,23 @@
 
 define( 'SYNDICATION_VERSION', 2.0 );
 
-if ( ! defined( 'PUSH_SYNDICATE_KEY' ) )
+if ( ! defined( 'PUSH_SYNDICATE_KEY' ) ) {
 	define( 'PUSH_SYNDICATE_KEY', 'PUSH_SYNDICATE_KEY' );
+}
 
 /**
  * Load syndication logger
  */
-require_once( dirname( __FILE__ ) . '/includes/class-syndication-logger.php' );
+require_once dirname( __FILE__ ) . '/includes/class-syndication-logger.php';
 Syndication_Logger::init();
 
-require_once( dirname( __FILE__ ) . '/includes/class-wp-push-syndication-server.php' );
+require_once dirname( __FILE__ ) . '/includes/class-wp-push-syndication-server.php';
 
-if ( defined( 'WP_CLI' ) && WP_CLI )
-	require_once( dirname( __FILE__ ) . '/includes/class-wp-cli.php' );
+if ( defined( 'WP_CLI' ) && WP_CLI ) {
+	require_once dirname( __FILE__ ) . '/includes/class-wp-cli.php';
+}
 
-$GLOBALS['push_syndication_server'] = new WP_Push_Syndication_Server;
+$GLOBALS['push_syndication_server'] = new WP_Push_Syndication_Server();
 
 // Create the event counter.
 require __DIR__ . '/includes/class-syndication-event-counter.php';
@@ -38,3 +40,17 @@
 // Create the site auto retry functionality
 require __DIR__ . '/includes/class-syndication-site-auto-retry.php';
 new Failed_Syndication_Auto_Retry();
+
+// Load encryption classes
+require_once dirname( __FILE__ ) . '/includes/class-syndication-encryption.php';
+require_once dirname( __FILE__ ) . '/includes/interface-syndication-encryptor.php';
+require_once dirname( __FILE__ ) . '/includes/class-syndication-encryptor-mcrypt.php';
+require_once dirname( __FILE__ ) . '/includes/class-syndication-encryptor-openssl.php';
+
+// On PHP 7.1 mcrypt is available, but will throw a deprecated error if its used. Therefore, checking for the
+// PHP version, instead of checking for mcrypt is a better approach.
+if ( version_compare( PHP_VERSION, '7.1', '<' ) ) {
+	Syndication_Encryption::set_encryptor( new Syndication_Encryptor_MCrypt() );
+} else {
+	Syndication_Encryption::set_encryptor( new Syndication_Encryptor_OpenSSL() );
+}

tests/bootstrap.php

@@ -26,3 +26,9 @@ function _manually_load_plugin() {
  */
 require_once dirname( __DIR__ ) . '/vendor/yoast/wp-test-utils/src/WPIntegration/bootstrap-functions.php';
 WPIntegration\bootstrap_it();
+
+/*
+ * Load tests dependencies
+ */
+
+require_once dirname( __FILE__ ) . '/class-encryptor-test-case.php';

tests/class-encryptor-test-case.php

@@ -0,0 +1,97 @@
+<?php
+namespace Syndication\Tests;
+
+use Yoast\WPTestUtils\WPIntegration\TestCase as WPIntegrationTestCase;
+
+/**
+ * Class EncryptorMCryptTest
+ *
+ * @requires extension mcrypt
+ */
+abstract class EncryptorTestCase extends WPIntegrationTestCase {
+	protected $simple_string;
+	protected $complex_array;
+	protected $encryptor;
+
+	/**
+	 * Runs before the test, set-up.
+	 */
+	public function setUp() {
+		$this->simple_string = 'this is a simple string!';
+		$this->complex_array = array(
+			'element' => 'this is a element',
+			'group'   => array(
+				'another',
+				'sub',
+				'array',
+				'info' => 'test',
+			),
+			'',
+			145,
+			1         => 20.04,
+			3         => true,
+		);
+	}
+
+	/**
+	 * Test a simple string encryption
+	 */
+	public function test_simple_encryption() {
+		$encrypted = $this->encryptor->encrypt( $this->simple_string );
+
+		self::assertIsString( $encrypted, 'assert if the string encryption returns string' );
+		self::assertEquals( base64_encode( base64_decode( $encrypted ) ), $encrypted, 'assert if the encrypted data is encoded in base64' );
+
+		return $encrypted;
+	}
+
+	/**
+	 * Test a simple string decryption.
+	 *
+	 * @param string $encrypted The encrypted string from the previous test.
+	 *
+	 * @depends test_simple_encryption
+	 */
+	public function test_simple_decryption( $encrypted ) {
+		$decrypted = $this->encryptor->decrypt( $encrypted );
+		self::assertEquals( $this->simple_string, $decrypted );
+	}
+
+	/**
+	 * Test a complex (array) encryption.
+	 */
+	public function test_complex_encryption() {
+		$encrypted = $this->encryptor->encrypt( $this->complex_array );
+
+		self::assertIsString( $encrypted, 'assert if the array encryption returns string' );
+		self::assertEquals( base64_encode( base64_decode( $encrypted ) ), $encrypted, 'assert if the encrypted data is encoded in base64' );
+
+		return $encrypted;
+	}
+
+	/**
+	 * Test an array decryption.
+	 *
+	 * @param string $encrypted The encrypted string from the previous test.
+	 *
+	 * @depends test_complex_encryption
+	 */
+	public function test_complex_decryption( $encrypted ) {
+		$decrypted = $this->encryptor->decrypt( $encrypted );
+
+		self::assertIsArray( $decrypted, 'assert if the decrypted data is an array' );
+		self::assertEquals( $this->complex_array, $decrypted, 'assert if the decrypted array is equal to the original array' );
+
+		// Test without associative set to true.
+		$decrypted = $this->encryptor->decrypt( $encrypted, false );
+		self::assertIsObject( $decrypted, 'assert if the decrypted data is an object' );
+		self::assertEquals( $decrypted->element, $this->complex_array['element'], 'assert if the first element is the same' );
+
+	}
+
+	/**
+	 * Test the expected cipher
+	 */
+	abstract public function test_cipher();
+
+}