wp-pay-gateways / mollie

src/Install.php

<?php
/**
 * Mollie install.
 *
 * @author    Pronamic <info@pronamic.eu>
 * @copyright 2005-2020 Pronamic
 * @license   GPL-3.0-or-later
 * @package   Pronamic\WordPress\Pay
 */

namespace Pronamic\WordPress\Pay\Gateways\Mollie;

/**
 * Title: Mollie install.
 * Description:
 * Copyright: 2005-2020 Pronamic
 * Company: Pronamic
 *
 * @author  Remco Tolsma
 * @version 3.0.0
 * @since   3.0.0
 */
class Install {
	/**
	 * Integration.
	 *
	 * @var Integration
	 */
	private $integration;

	/**
	 * Construct install.
	 *
	 * @link https://github.com/woocommerce/woocommerce/blob/4.0.0/includes/class-woocommerce.php#L368
	 * @link https://github.com/woocommerce/woocommerce/blob/4.0.0/includes/class-wc-install.php#L1568
	 * @link https://github.com/woocommerce/woocommerce/blob/4.0.0/includes/class-wc-install.php#L153-L166
	 * @param Integration $integration Integration.
	 */
	public function __construct( Integration $integration ) {
		$this->integration = $integration;

		add_action( 'init', array( $this, 'check_version' ), 5 );
	}

	/**
	 * Check version.
	 *
	 * @link https://github.com/woocommerce/woocommerce/blob/4.0.0/includes/class-wc-install.php#L168-L178
	 */
	public function check_version() {
		$version_option = $this->integration->get_version_option();

		if ( version_compare( $version_option, $this->integration->get_version(), '<' ) ) {
			$this->install();
		}
	}

	/**
	 * Install.
	 *
	 * @link https://github.com/woocommerce/woocommerce/blob/4.0.0/includes/class-wc-install.php#L272-L306
	 */
	public function install() {
		$this->create_tables();
		$this->add_foreign_keys();
		$this->convert_user_meta();

		$this->integration->update_version_option();
	}

	/**
	 * Create tables.
	 *
	 * @link https://github.com/woocommerce/woocommerce/blob/4.0.0/includes/class-wc-install.php#L630-L720
	 */
	private function create_tables() {
		global $wpdb;

		/**
		 * Requirements.
		 */
		require_once ABSPATH . 'wp-admin/includes/upgrade.php';

		/**
		 * Table options.
		 *
		 * In MySQL 5.6, InnoDB is the default MySQL storage engine. Unless you
		 * have configured a different default storage engine,  issuing a
		 * CREATE TABLE statement without an ENGINE= clause creates an InnoDB
		 * table.
		 *
		 * @link https://dev.mysql.com/doc/refman/5.6/en/innodb-introduction.html
		 *
		 * If a storage engine is specified that is not available, MySQL uses
		 * the default engine instead. Normally, this is MyISAM. For example,
		 * if a table definition includes the ENGINE=INNODB option but the MySQL
		 * server does not support INNODB tables, the table is created as a
		 * MyISAM table.
		 *
		 * @link https://dev.mysql.com/doc/refman/5.6/en/create-table.html
		 */
		$table_options = 'ENGINE=InnoDB ' . $wpdb->get_charset_collate();

		/**
		 * Queries.
		 *
		 * @link https://github.com/WordPress/WordPress/blob/5.3/wp-admin/includes/schema.php
		 */
		$queries = "
			CREATE TABLE $wpdb->pronamic_pay_mollie_organizations (
				id bigint(20) unsigned NOT NULL AUTO_INCREMENT,
				mollie_id varchar(16) NOT NULL,
				name varchar(128) DEFAULT NULL,
				email varchar(100) DEFAULT NULL,
				PRIMARY KEY  ( id ),
				UNIQUE KEY mollie_id ( mollie_id )
			) $table_options;
			CREATE TABLE $wpdb->pronamic_pay_mollie_profiles (
				id bigint(20) unsigned NOT NULL AUTO_INCREMENT,
				mollie_id varchar(16) NOT NULL,
				organization_id bigint(20) unsigned DEFAULT NULL,
				name varchar(128) DEFAULT NULL,
				email varchar(100) DEFAULT NULL,
				api_key_test varchar(35) DEFAULT NULL,
				api_key_live varchar(35) DEFAULT NULL,
				PRIMARY KEY  ( id ),
				UNIQUE KEY mollie_id ( mollie_id ),
				KEY organization_id ( organization_id )
			) $table_options;
			CREATE TABLE $wpdb->pronamic_pay_mollie_customers (
				id bigint(20) unsigned NOT NULL AUTO_INCREMENT,
				mollie_id varchar(16) NOT NULL,
				organization_id bigint(20) unsigned DEFAULT NULL,
				profile_id bigint(20) unsigned DEFAULT NULL,
				test_mode tinyint(1) NOT NULL,
				email varchar(100) DEFAULT NULL,
				name varchar(255) DEFAULT NULL,
				PRIMARY KEY  ( id ),
				UNIQUE KEY mollie_id ( mollie_id ),
				KEY organization_id ( organization_id ),
				KEY profile_id ( profile_id ),
				KEY test_mode ( test_mode ),
				KEY email ( email )
			) $table_options;
			CREATE TABLE $wpdb->pronamic_pay_mollie_customer_users (
				id bigint(20) unsigned NOT NULL AUTO_INCREMENT,
				customer_id bigint(20) unsigned NOT NULL,
				user_id bigint(20) unsigned NOT NULL,
				PRIMARY KEY  ( id ),
				UNIQUE KEY customer_user ( customer_id, user_id )
			) $table_options;
		";

		/**
		 * Execute.
		 *
		 * @link https://developer.wordpress.org/reference/functions/dbdelta/
		 * @link https://github.com/WordPress/WordPress/blob/5.3/wp-admin/includes/upgrade.php#L2538-L2915
		 */
		\dbDelta( $queries );
	}

	/**
	 * Add foreign keys.
	 */
	private function add_foreign_keys() {
		global $wpdb;

		/**
		 * Foreign keys.
		 *
		 * @link https://core.trac.wordpress.org/ticket/19207
		 * @link https://dev.mysql.com/doc/refman/5.6/en/create-table-foreign-keys.html
		 */
		$data = array(
			(object) array(
				'table' => $wpdb->pronamic_pay_mollie_profiles,
				'name'  => 'fk_profile_organization_id',
				'query' => "
					ALTER TABLE  $wpdb->pronamic_pay_mollie_profiles
					ADD CONSTRAINT fk_profile_organization_id
					FOREIGN KEY ( organization_id )
					REFERENCES $wpdb->pronamic_pay_mollie_organizations ( id )
					ON DELETE RESTRICT
					ON UPDATE RESTRICT
					;
				",
			),
			(object) array(
				'table' => $wpdb->pronamic_pay_mollie_customers,
				'name'  => 'fk_customer_organization_id',
				'query' => "
					ALTER TABLE $wpdb->pronamic_pay_mollie_customers
					ADD CONSTRAINT fk_customer_organization_id
					FOREIGN KEY ( organization_id )
					REFERENCES $wpdb->pronamic_pay_mollie_organizations ( id )
					ON DELETE RESTRICT
					ON UPDATE RESTRICT
					;
				",
			),
			(object) array(
				'table' => $wpdb->pronamic_pay_mollie_customers,
				'name'  => 'fk_customer_profile_id',
				'query' => "
					ALTER TABLE $wpdb->pronamic_pay_mollie_customers
					ADD CONSTRAINT fk_customer_profile_id
					FOREIGN KEY ( profile_id )
					REFERENCES $wpdb->pronamic_pay_mollie_profiles ( id )
					ON DELETE RESTRICT
					ON UPDATE RESTRICT
					;
				",
			),
			(object) array(
				'table' => $wpdb->pronamic_pay_mollie_customer_users,
				'name'  => 'fk_customer_id',
				'query' => "
					ALTER TABLE $wpdb->pronamic_pay_mollie_customer_users
					ADD CONSTRAINT fk_customer_id
					FOREIGN KEY customer_id ( customer_id )
					REFERENCES $wpdb->pronamic_pay_mollie_customers ( id )
					ON DELETE RESTRICT
					ON UPDATE RESTRICT
					;
				",
			),
			(object) array(
				'table' => $wpdb->pronamic_pay_mollie_customer_users,
				'name'  => 'fk_customer_user_id',
				'query' => "
					ALTER TABLE $wpdb->pronamic_pay_mollie_customer_users
					ADD CONSTRAINT fk_customer_user_id
					FOREIGN KEY user_id ( user_id )
					REFERENCES $wpdb->users ( id )
					ON DELETE CASCADE
					ON UPDATE CASCADE
					;
				",
			),
		);

		foreach ( $data as $item ) {
			try {
				$this->add_foreign_key( $item );
			} catch ( \Exception $e ) {
				// Foreign keys are not strictly required.
				continue;
			}
		}
	}

	/**
	 * Add specified foreign key.
	 *
	 * @param object $item Foreig key data.
	 * @throws \Exception Throws exception when adding foreign key fails.
	 */
	private function add_foreign_key( $item ) {
		global $wpdb;

		/**
		 * Check if foreign key exists
		 *
		 * @link https://github.com/woocommerce/woocommerce/blob/3.9.0/includes/class-wc-install.php#L663-L681
		 */
		$result = $wpdb->get_var(
			$wpdb->prepare(
				"
			SELECT COUNT(*)
			FROM information_schema.TABLE_CONSTRAINTS
			WHERE CONSTRAINT_SCHEMA = %s
			AND CONSTRAINT_NAME = %s
			AND CONSTRAINT_TYPE = 'FOREIGN KEY'
			AND TABLE_NAME = %s
			",
				$wpdb->dbname,
				$item->name,
				$item->table
			)
		);

		if ( null === $result ) {
			throw new \Exception(
				\sprintf(
					'Could not count foreign keys: %s, database error: %s.',
					$item->name,
					$wpdb->last_error
				)
			);
		}

		$number_constraints = \intval( $result );

		if ( 0 === $number_constraints ) {
			// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Query is prepared.
			$result = $wpdb->query( $item->query );

			if ( false === $result ) {
				throw new \Exception(
					\sprintf(
						'Could not add foreign key: %s, database error: %s.',
						$item->name,
						$wpdb->last_error
					)
				);
			}
		}
	}

	/**
	 * Convert user meta.
	 *
	 * @throws \Exception Throws exception when database update query fails.
	 */
	private function convert_user_meta() {
		global $wpdb;

		$query = "
			INSERT IGNORE INTO $wpdb->pronamic_pay_mollie_customers (
				mollie_id,
				test_mode
			)
			SELECT
				meta_value AS mollie_id,
				'_pronamic_pay_mollie_customer_id_test' = meta_key AS test_mode
			FROM
				$wpdb->usermeta
			WHERE
				meta_key IN (
					'_pronamic_pay_mollie_customer_id',
					'_pronamic_pay_mollie_customer_id_test'
				)
					AND
				meta_value != ''
			;
		";

		// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Query is prepared.
		$result = $wpdb->query( $query );

		if ( false === $result ) {
			throw new Exception(

The type Pronamic\WordPress\Pay\Gateways\Mollie\Exception was not found. Did you mean Exception? If so, make sure to prefix the type with \.

				sprintf(
					'Could not convert user meta, database error: %s.',
					$wpdb->last_error
				)
			);
		}

		$query = "
			INSERT IGNORE INTO $wpdb->pronamic_pay_mollie_customer_users (
				customer_id,
				user_id
			)
			SELECT
				mollie_customer.id AS mollie_customer_id,
				wp_user.ID AS wp_user_id
			FROM
				$wpdb->pronamic_pay_mollie_customers AS mollie_customer
					INNER JOIN
				$wpdb->usermeta AS wp_user_meta
						ON wp_user_meta.meta_value = mollie_customer.mollie_id
					INNER JOIN
				$wpdb->users AS wp_user
						ON wp_user_meta.user_id = wp_user.ID
			WHERE
				wp_user_meta.meta_key IN (
					'_pronamic_pay_mollie_customer_id',
					'_pronamic_pay_mollie_customer_id_test'
				)
					AND
				wp_user_meta.meta_value != ''
			;
		";

		// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Query is prepared.
		$result = $wpdb->query( $query );

		if ( false === $result ) {
			throw new Exception(
				sprintf(
					'Could not convert user meta, database error: %s.',
					$wpdb->last_error
				)
			);
		}
	}
}