WP-CLI

# Lumen Press: shared WP-CLI configuration, committed to the repository.
path: wordpress
url: https://lumenpress.test
apache_modules:
  - mod_rewrite
disabled_commands:
  - db drop
  - db reset

# Defaults for one subcommand.
post list:
  fields: ID,post_title,post_status

@staging:
  ssh: deploy@staging.lumenpress.example/srv/www/staging.lumenpress.example
  url: https://staging.lumenpress.example
@production:
  ssh: deploy@lumenpress.example:2222/srv/www/lumenpress.example
  url: https://lumenpress.example
@remote:
  - @staging
  - @production

# Per-developer overrides, ignored by Git. Without "inherit", wp-cli.yml is not read at all.
_:
  inherit: wp-cli.yml
user: maria.editor

$ scp books.csv deploy@staging.lumenpress.example:/tmp/books.csv
$ wp @staging lumen import /tmp/books.csv --user=lena.catalogue
Success: Imported 50 books, skipped 0.
$ wp @staging --debug option get home 2>&1 | grep 'Running SSH'
Debug (bootstrap): Running SSH command: ssh -T -vvv 'deploy@staging.lumenpress.example' 'cd '\''/srv/www/staging.lumenpress.example'\''; WP_CLI_RUNTIME_ALIAS=... wp @staging '\''--debug'\'' '\''option'\'' '\''get'\'' '\''home'\''' (0.03s)
$ wp @remote option get home; echo "exit=$?"
@staging
https://staging.lumenpress.example
@production
Error: Cannot connect over SSH using provided configuration.
exit=0

$ php -d memory_limit=512M "$(command -v wp)" package install wp-cli/doctor-command
  - wp-cli/doctor-command dev-main requires wp-cli/wp-cli ^3.0 -> found wp-cli/wp-cli[2.12.0] but it does not match the constraint.
Error: Package installation failed (Composer return code 2).
$ php -d memory_limit=512M "$(command -v wp)" package install wp-cli/doctor-command:^2.3
Success: Package installed.
$ wp doctor check autoload-options-size constant-wp-debug-falsy core-verify-checksums
name	status	message
core-verify-checksums	success	WordPress verifies against its checksums.
autoload-options-size	success	Autoloaded options size (37.18kb) is less than threshold (900kb).
constant-wp-debug-falsy	success	Constant 'WP_DEBUG' is defined falsy.

if ( defined( 'WP_CLI' ) && WP_CLI ) {
	\WP_CLI::add_command( 'lumen import', Cli\Import_Command::class );
}

<?php
/**
 * The wp lumen import command.
 *
 * @package Lumen\Catalog
 */

namespace Lumen\Catalog\Cli;

use WP_CLI;
use WP_CLI\Utils;

defined( 'ABSPATH' ) || exit;

/**
 * Imports books into the catalogue from a CSV file.
 */
final class Import_Command {

	// Columns the CSV header must contain, in any order.
	const COLUMNS = array( 'title', 'isbn', 'pages', 'published_on', 'genre' );

	/**
	 * Imports books from a CSV file.
	 *
	 * Every valid row becomes a published book. A row whose ISBN is already in the
	 * catalogue, or earlier in the same file, is skipped, so the command can run
	 * again after the invalid rows have been fixed.
	 *
	 * ## OPTIONS
	 *
	 * <file>
	 * : UTF-8 CSV file whose header is title,isbn,pages,published_on,genre.
	 *
	 * [--dry-run]
	 * : Validate every row and report the result without writing anything.
	 *
	 * [--porcelain]
	 * : Print only the IDs of the new books, one per line.
	 *
	 * [--format=<format>]
	 * : Format of the report of rows that were not imported.
	 * ---
	 * default: table
	 * options:
	 *   - table
	 *   - csv
	 *   - json
	 *   - yaml
	 * ---
	 *
	 * ## EXIT STATUS
	 *
	 * 0 when every row was imported or skipped, 1 when the file cannot be used,
	 * 2 when at least one row was invalid or could not be saved.
	 *
	 * @param string[] $args       Positional arguments: the CSV file.
	 * @param array    $assoc_args Associative arguments and flags.
	 */
	public function __invoke( $args, $assoc_args ) {
		list( $file ) = $args;
		$dry_run      = (bool) Utils\get_flag_value( $assoc_args, 'dry-run', false );
		$porcelain    = (bool) Utils\get_flag_value( $assoc_args, 'porcelain', false );
		$format       = Utils\get_flag_value( $assoc_args, 'format', 'table' );

		$rows = $this->read_csv( $file );

		if ( ! $dry_run && 0 === get_current_user_id() ) {
			WP_CLI::error( 'Books need an author: add --user=<login>.' );
		}

		$known    = $this->existing_isbns();
		$created  = array();
		$problems = array();
		$progress = $porcelain ? null : Utils\make_progress_bar( $dry_run ? 'Checking books' : 'Importing books', count( $rows ) );

		wp_defer_term_counting( true );

		foreach ( $rows as $line => $row ) {
			$error  = $this->validate( $row );
			$key    = self::digits( $row['isbn'] ?? '' );
			$report = array(
				'line'  => $line,
				'isbn'  => $row['isbn'] ?? '',
				'title' => $row['title'] ?? '',
			);

			if ( '' !== $error ) {
				$problems[] = $report + array(
					'result' => 'invalid',
					'reason' => $error,
				);
				$key        = '';
			} elseif ( isset( $known[ $key ] ) ) {
				$problems[] = $report + array(
					'result' => 'skipped',
					'reason' => 'ISBN already in the catalogue',
				);
			} elseif ( ! $dry_run ) {
				$post_id = lumen_catalog_import_book( $row, 'csv' );

				if ( is_wp_error( $post_id ) ) {
					$problems[] = $report + array(
						'result' => 'failed',
						'reason' => $post_id->get_error_message(),
					);
				} else {
					update_post_meta( $post_id, 'lp_published_on', $row['published_on'] );
					wp_set_object_terms( $post_id, $row['genre'], 'lp_genre' );
					$created[] = $post_id;
				}
			}

			if ( '' !== $key ) {
				$known[ $key ] = true;
			}
			if ( $progress ) {
				$progress->tick();
			}
		}

		wp_defer_term_counting( false );

		if ( $progress ) {
			$progress->finish();
		}

		if ( $porcelain ) {
			array_map( array( WP_CLI::class, 'line' ), $created );
		} elseif ( $problems ) {
			Utils\format_items( $format, $problems, array( 'line', 'isbn', 'title', 'result', 'reason' ) );
		}

		$bad = count( wp_list_filter( $problems, array( 'result' => 'skipped' ), 'NOT' ) );

		if ( $bad > 0 ) {
			WP_CLI::error( sprintf( '%d of %d rows could not be imported.', $bad, count( $rows ) ), 2 );
		}

		if ( ! $porcelain ) {
			WP_CLI::success(
				sprintf(
					$dry_run ? 'Dry run: %d rows would be imported, %d skipped.' : 'Imported %d books, skipped %d.',
					count( $rows ) - count( $problems ),
					count( $problems )
				)
			);
		}
	}

	/**
	 * Reads the CSV file into rows keyed by line number; stops on unusable files.
	 *
	 * @param string $file Path to the file.
	 * @return array<int, array<string, string>> Rows; a malformed row holds only an `error` key.
	 */
	private function read_csv( $file ) {
		if ( ! is_file( $file ) || ! is_readable( $file ) ) {
			WP_CLI::error( "Cannot read {$file}." );
		}

		$csv = new \SplFileObject( $file );
		$csv->setFlags( \SplFileObject::READ_CSV | \SplFileObject::SKIP_EMPTY | \SplFileObject::READ_AHEAD );

		$header = null;
		$rows   = array();
		$line   = 0;

		foreach ( $csv as $fields ) {
			++$line;
			$fields = array_map( 'trim', $fields );

			if ( null === $header ) {
				$fields[0] = preg_replace( '/^\xEF\xBB\xBF/', '', $fields[0] ); // UTF-8 byte order mark.
				$header    = array_map( 'strtolower', $fields );
				$missing   = array_diff( self::COLUMNS, $header );
				if ( $missing ) {
					WP_CLI::error( 'Missing columns: ' . implode( ', ', $missing ) . '.' );
				}
				continue;
			}

			$rows[ $line ] = count( $fields ) === count( $header )
				? array_combine( $header, $fields )
				: array( 'error' => sprintf( 'Expected %d fields, found %d', count( $header ), count( $fields ) ) );
		}

		if ( ! $rows ) {
			WP_CLI::error( "{$file} has no data rows." );
		}

		return $rows;
	}

	/**
	 * Checks one row.
	 *
	 * @param array<string, string> $row Row from the CSV file.
	 * @return string Error message, or an empty string when the row is valid.
	 */
	private function validate( array $row ) {
		if ( isset( $row['error'] ) ) {
			return $row['error'];
		}
		if ( '' === $row['title'] ) {
			return 'Empty title';
		}

		$digits = str_split( self::digits( $row['isbn'] ) );
		$sum    = 0;
		foreach ( array_slice( $digits, 0, 12 ) as $i => $digit ) {
			$sum += (int) $digit * ( 0 === $i % 2 ? 1 : 3 );
		}
		if ( 13 !== count( $digits ) || ( 10 - $sum % 10 ) % 10 !== (int) $digits[12] ) {
			return 'Invalid ISBN-13';
		}

		if ( ! ctype_digit( $row['pages'] ) || (int) $row['pages'] < 1 ) {
			return 'Pages must be a positive whole number';
		}

		$date = \DateTime::createFromFormat( '!Y-m-d', $row['published_on'] );
		if ( ! $date || $date->format( 'Y-m-d' ) !== $row['published_on'] ) {
			return 'published_on must be YYYY-MM-DD';
		}
		return '';
	}

	/**
	 * Strips everything but digits, so 978-1-23456-789-7 and 9781234567897 match.
	 *
	 * @param string $isbn ISBN as written.
	 * @return string Digits only.
	 */
	private static function digits( $isbn ) {
		return preg_replace( '/\D/', '', (string) $isbn );
	}

	/**
	 * Loads the ISBNs already in the catalogue, in one query.
	 *
	 * @return array<string, true> Digits-only ISBNs as keys.
	 */
	private function existing_isbns() {
		global $wpdb;

		// phpcs:ignore WordPress.DB.DirectDatabaseQuery -- one read per run, a cache would be stale.
		$isbns = $wpdb->get_col(
			$wpdb->prepare(
				"SELECT pm.meta_value FROM {$wpdb->postmeta} pm
				INNER JOIN {$wpdb->posts} p ON p.ID = pm.post_id
				WHERE pm.meta_key = %s AND p.post_type = %s AND p.post_status <> %s",
				'lp_isbn',
				'lp_book',
				'trash'
			)
		);

		return array_fill_keys( array_map( array( self::class, 'digits' ), $isbns ), true );
	}
}