command.php

<?php

namespace mwithheld\Orphan_Tables\Commands;

// Internal API ref https://make.wordpress.org/cli/handbook/references/internal-api/
use WP_CLI;

if (!defined('WP_CLI') || !class_exists('WP_CLI') || empty(WP_CLI)) {
    echo 'WP_CLI is not defined';
    return;
}

class WP_Multisite_Orphans extends \WP_CLI_Command {

    //WP database, obtained from WP code ($GLOBALS['wpdb']).
    protected $db;
    //WP-CLI flags used in this package.
    private $flags = [
        'dryrun' => ['name' => 'dry-run', 'default' => false],
        'limit'  => ['name' => 'limit', 'default' => 0],
    ];
    //Label to use when we rename DB tables and the target parent dir.
    private $rename_label;
    //Source folders to look for orphaned folders in.  Must be below wp uploads dir.
    private $source_dirs = [];
    //Folder to move orphaned folders into.  Must be below wp uploads dir.
    private $target_dir = '';
    //WP uploads folder path from WP.
    private $wpuploadsdir = '';

    //==========================================================================
    // Methods that provide a user-accessible interface for this package.
    //==========================================================================

    /**
     * Set up.
     */
    public function __construct() {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        \WP_CLI::debug("{$fxn}::Started");

        if (!is_multisite()) {
            WP_CLI::error('This is not a WP Multisite installation. This command is for Multisite only.');
        }

        $this->db = $GLOBALS['wpdb'];

        $this->rename_label = \str_replace(__NAMESPACE__ . '\\', '', __CLASS__);
        $this->flags = (object) $this->flags;
        foreach ($this->flags as $key => $value) {
            $this->flags->$key = (object) $value;
        }
    }

    /**
     * If a class implements __invoke(), the command name will be registered to that method and no other methods of that class will be registered as commands.
     *
     * @param array $args
     * @param array $assoc_args
      public function __invoke($args, $assoc_args) {
      $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
      \WP_CLI::debug("{$fxn}::Started");
      }
     */

    /**
     * Prints the rename label. No parameters.
     *
     * ## EXAMPLE
     * wp-cli wp-multisite-orphans show_label
     *
     * @return void
     */
    public function show_label() {
        \WP_CLI::success("$this->rename_label");
        return $this->rename_label;
    }

    /**
     * Prints the folders we look into for orphaned folders. No parameters.
     *
     * ## EXAMPLE
     * wp-cli wp-multisite-orphans show_source_dirs
     *
     * @return void
     */
    public function show_source_dirs() {
        $returnThis = $this->get_target_dir();
        \WP_CLI::success(serialize($returnThis));
        return $returnThis;
    }

    /**
     * Prints the destination folder when we move orphaned folders. No parameters.
     *
     * ## EXAMPLE
     * wp-cli wp-multisite-orphans show_target_dir
     *
     * @return void
     */
    public function show_target_dir() {
        $returnThis = $this->get_target_dir();
        \WP_CLI::success($returnThis);
        return $returnThis;
    }

    /**
     * Prints orphan table names in plain text; no changes are made. Renamed tables do not show up as orphaned tables. No parameters.
     *
     * ## EXAMPLE
     * wp-cli wp-multisite-orphans list_tables
     *
     * @return void
     */
    public function list_tables(): array {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        \WP_CLI::debug("{$fxn}::Started");

        $items = $this->get_orphan_tables();
        if (\count($items) < 1) {
            \WP_CLI::success('No tables found');
            return [];
        }

        foreach ($items as &$i) {
            \WP_CLI::log("$i");
        }
        \WP_CLI::success(\count($items) . ' orphan tables names');
        return $items;
    }

    /**
     * Prints drop statements for orphan tables; no changes are made. Renamed tables do not show up as orphaned tables. No parameters.
     *
     * ## EXAMPLE
     * wp-cli wp-multisite-orphans list_drop_tables
     *
     * @return void
     */
    public function list_drop_tables(): array {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        \WP_CLI::debug("{$fxn}::Started");

        $internal = false;
        $caller = \array_slice(\debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT | DEBUG_BACKTRACE_IGNORE_ARGS, 2), 1, 1)[0];
        //\WP_CLI::debug("{$fxn}::caller=".\print_r($caller, true));
        if (isset($caller['class']) && !empty($caller['class']) && $caller['class'] == __CLASS__) {
            $internal = true;
            \WP_CLI::debug("{$fxn}::This is an interal function call");
        }

        $items = $this->get_orphan_tables();
        $returnThis = [];
        if (\count($items) < 1) {
            !$internal && \WP_CLI::success('No tables found');
            return $returnThis;
        }

        $returnThis = $this->create_drop_statements($items);
        foreach ($returnThis as &$sql) {
            !$internal && \WP_CLI::log($sql);
        }
        !$internal && \WP_CLI::success(\count($items) . ' orphan tables drop statements');
        return $returnThis;
    }

    /**
     * Prints drop statements for renamed tables; no changes are made. No parameters.
     *
     * ## EXAMPLE
     * wp-cli wp-multisite-orphans list_drop_renamed_tables
     *
     * @return void
     */
    public function list_drop_renamed_tables(): array {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        \WP_CLI::debug("{$fxn}::Started");

        $internal = false;
        $caller = \array_slice(\debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT | DEBUG_BACKTRACE_IGNORE_ARGS, 2), 1, 1)[0];
        //\WP_CLI::debug("{$fxn}::caller=".\print_r($caller, true));
        if (isset($caller['class']) && !empty($caller['class']) && $caller['class'] == __CLASS__) {
            $internal = true;
            \WP_CLI::debug("{$fxn}::This is an interal function call");
        }

        $items = $this->get_renamed_tables();
        $returnThis = [];
        if (\count($items) < 1) {
            !$internal && \WP_CLI::success('No tables found');
            return $returnThis;
        }

        $returnThis = $this->create_drop_statements($items);
        foreach ($returnThis as &$sql) {
            !$internal && \WP_CLI::log($sql);
        }
        !$internal && \WP_CLI::success(\count($items) . ' orphan tables drop statements');
        return $returnThis;
    }

    /**
     * Prints rename statements for orphan tables using the standard label {show_label}. No changes are made. Renamed tables do not show up as orphaned tables. No parameters.
     *
     * ## EXAMPLE
     * wp-cli wp-multisite-orphans list_rename_tables
     *
     * @return void
     */
    public function list_rename_tables(): array {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        \WP_CLI::debug("{$fxn}::Started");
        $internal = false;
        $caller = \array_slice(\debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT | DEBUG_BACKTRACE_IGNORE_ARGS, 2), 1, 1)[0];
        //\WP_CLI::debug("{$fxn}::caller=".\print_r($caller, true));
        if (isset($caller['class']) && !empty($caller['class']) && $caller['class'] == __CLASS__) {
            $internal = true;
            \WP_CLI::debug("{$fxn}::This is an interal function call");
        }

        $items = $this->get_orphan_tables();
        $returnThis = [];
        if (\count($items) < 1) {
            !$internal && \WP_CLI::success('No tables found');
            return $returnThis;
        }

        $tablename_new = '';
        $sql = '';
        foreach ($items as &$i) {
            $tablename_new = \str_replace($i, "{$this->db->prefix}" . $this->rename_label . '_' . $i, "{$i}");
            $sql = "RENAME TABLE {$i} TO {$tablename_new};";
            !$internal && \WP_CLI::log($sql);
            $returnThis[] = $sql;
        }
        !$internal && \WP_CLI::success(\count($items) . ' orphan tables rename statements');
        return $returnThis;
    }

    /**
     * Prints a list of orphaned tables renamed by this package; no changes are made. Renamed tables do not show up as orphaned tables. No parameters.
     *
     * ## EXAMPLE
     * wp-cli wp-multisite-orphans list_already_renamed_tables
     *
     * @return void
     */
    public function list_already_renamed_tables(): array {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        \WP_CLI::debug("{$fxn}::Started");

        $items = $this->get_renamed_tables();
        if (\count($items) < 1) {
            \WP_CLI::success('No tables found');
            return[];
        }

        foreach ($items as &$i) {
            \WP_CLI::log("{$i}");
        }
        \WP_CLI::success(\count($items) . ' orphan tables renamed by this package');
        return $items;
    }

    /**
     * Prints a list of orphaned folders in wp-content/uploads/sites/<n> and wp-content/blogs.dir/<n>. No parameters.
     *
     * ## EXAMPLE
     * wp-cli wp-multisite-orphans list_folders
     *
     * @return void
     */
    public function list_folders(): array {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        \WP_CLI::debug("{$fxn}::Started");

        $items = $this->get_orphan_folders();
        if (\count($items) < 1) {
            \WP_CLI::success("No orphaned folders found");
            return[];
        }

        foreach ($items as &$i) {
            \WP_CLI::log("{$i}");
        }
        \WP_CLI::success(\count($items) . ' orphaned folders');
        return $items;
    }

    /**
     * Prints a list of orphaned folders that were moved by this package. No parameters.
     *
     * ## EXAMPLE
     * wp-cli wp-multisite-orphans list_moved_folders
     *
     * @return void
     */
    public function list_moved_folders(): array {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        \WP_CLI::debug("{$fxn}::Started");

        $items = $this->get_moved_folders();
        if (\count($items) < 1) {
            \WP_CLI::success("No moved folders found");
            return[];
        }

        foreach ($items as &$i) {
            \WP_CLI::log($i);
        }
        
        $targetdir = $this->get_target_dir();
        \WP_CLI::success(\count($items) . " moved folders found under target dir={$targetdir}");
        return $items;
    }

    /**
     * Rename orphaned tables with a standard label + hashed table name. Renamed tables do not show up as orphaned tables.
     *
     * ## PARAMETERS
     *      --limit=<int> Only attempt rename on this number of tables (when sorted alphabetically ASC).
     *      --dry-run Do not actually make any changes - just show what would be done.
     *
     * ## EXAMPLE
     * wp-cli wp-multisite-orphans do_rename_tables
     * wp-cli wp-multisite-orphans do_rename_tables --dry-run
     * wp-cli wp-multisite-orphans do_rename_tables --limit=1 --debug --dry-run --yes
     *
     * @param array $args Command-line arguments array from WP-CLI. Unused here.
     * @param array $assoc_args Command line flags from WP-CLI. Flags specifically used by this package:
     *
     * @return object {changed=><int>, failed=><int>}
     */
    public function do_rename_tables(array $args, array $assoc_args): \stdClass {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        \WP_CLI::debug("{$fxn}::Started with args=" . serialize($args) . '; $assoc_args=' . serialize($assoc_args));

        \WP_CLI::confirm('BE CAREFUL, this cannot be easily undone so please backup your database before proceeding. Are you sure you want to proceed?', $assoc_args);

        $dryrun = \WP_CLI\Utils\get_flag_value($assoc_args, $this->flags->dryrun->name, false);
        $dryrun && \WP_CLI::log("{$fxn}::Dry run, so do not actually make any changes");

        $limit = \WP_CLI\Utils\get_flag_value($assoc_args, $this->flags->limit->name, 0);
        $limit && \WP_CLI::log("{$fxn}::Limiting to {$limit} tables");

        $results = $this->execute_ddl($this->list_rename_tables(), $limit, $dryrun);

        \WP_CLI::success("Processed " . ($results->changed + $results->failed) . " tables: Changed={$results->changed}; Failed={$results->failed}");
        return $results;
    }

    /**
     * Drop orphaned tables. Renamed tables do not show up as orphaned tables.
     *
     * ## PARAMETERS
     *      --limit=<int> Only attempt rename on this number of tables (when sorted alphabetically ASC).
     *      --dry-run Do not actually make any changes - just show what would be done.
     *
     * ## EXAMPLE
     * wp-cli wp-multisite-orphans do_drop_tables
     * wp-cli wp-multisite-orphans do_drop_tables --dry-run
     * wp-cli wp-multisite-orphans do_drop_tables --limit=14 --debug --dry-run --yes
     *
     * @param array $args Command-line arguments array from WP-CLI. Unused here.
     * @param array $assoc_args Command line flags from WP-CLI. Flags specifically used by this package:
     *
     * @return \stdClass Result tallies {changed=><int>, failed=><int>}
     */
    public function do_drop_tables(array $args, array $assoc_args): \stdClass {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        \WP_CLI::debug("{$fxn}::Started with args=" . serialize($args) . '; $assoc_args=' . serialize($assoc_args));

        \WP_CLI::confirm('BE CAREFUL, this cannot be undone so please backup your database before proceeding. Are you sure you want to proceed?', $assoc_args);

        $dryrun = \WP_CLI\Utils\get_flag_value($assoc_args, $this->flags->dryrun->name, false);
        $dryrun && \WP_CLI::log("{$fxn}::Dry run, so do not actually make any changes");

        $limit = \WP_CLI\Utils\get_flag_value($assoc_args, $this->flags->limit->name, 0);
        $limit && \WP_CLI::log("{$fxn}::Limiting to {$limit} tables");

        $results = $this->execute_ddl($this->list_drop_tables(), $limit, $dryrun);

        \WP_CLI::success("Processed " . ($results->changed + $results->failed) . " tables: Changed={$results->changed}; Failed={$results->failed}");
        return $results;
    }

    /**
     * Drop tables that were renamed by this package.
     *
     * ## PARAMETERS
     *      --limit=<int> Only attempt rename on this number of tables (when sorted alphabetically ASC).
     *      --dry-run Do not actually make any changes - just show what would be done.
     *
     * ## EXAMPLE
     * wp-cli wp-multisite-orphans do_drop_renamed_tables
     * wp-cli wp-multisite-orphans do_drop_renamed_tables --dry-run
     * wp-cli wp-multisite-orphans do_drop_renamed_tables --limit=2 --debug --dry-run --yes
     *
     * @param array $args Command-line arguments array from WP-CLI. Unused here.
     * @param array $assoc_args Command line flags from WP-CLI. Flags specifically used by this package:
     *
     * @return \stdClass Result tallies {changed=><int>, failed=><int>}
     */
    public function do_drop_renamed_tables(array $args, array $assoc_args): \stdClass {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        \WP_CLI::debug("{$fxn}::Started with args=" . serialize($args) . '; $assoc_args=' . serialize($assoc_args));

        \WP_CLI::confirm('BE CAREFUL, this cannot be undone so please backup your database before proceeding. Are you sure you want to proceed?', $assoc_args);

        $dryrun = \WP_CLI\Utils\get_flag_value($assoc_args, $this->flags->dryrun->name, false);
        $dryrun && \WP_CLI::log("{$fxn}::Dry run, so do not actually make any changes");

        $limit = \WP_CLI\Utils\get_flag_value($assoc_args, $this->flags->limit->name, 0);
        $limit && \WP_CLI::log("{$fxn}::Limiting to {$limit} tables");

        $results = $this->execute_ddl($this->list_drop_renamed_tables(), $limit, $dryrun);

        \WP_CLI::success("Processed " . ($results->changed + $results->failed) . " tables: Changed={$results->changed}; Failed={$results->failed}");
        return $results;
    }

    /**
     * Move orphaned folders into a wp uploads folder named for this package.
     *
     * ## PARAMETERS
     *      --limit=<int> Only attempt rename on this number of tables (when sorted alphabetically ASC).
     *      --dry-run Do not actually make any changes - just show what would be done.
     *
     * ## EXAMPLE
     * wp-cli wp-multisite-orphans do_move_folders
     * wp-cli wp-multisite-orphans do_move_folders --dry-run
     * wp-cli wp-multisite-orphans do_move_folders --limit=2 --debug --dry-run --yes
     *
     * @param array $args Command-line arguments array from WP-CLI. Unused here.
     * @param array $assoc_args Command line flags from WP-CLI. Flags specifically used by this package:
     *
     * @return \stdClass Result tallies {changed=><int>, failed=><int>}
     */
    public function do_move_folders(array $args, array $assoc_args): \stdClass {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        \WP_CLI::debug("{$fxn}::Started with args=" . serialize($args) . '; $assoc_args=' . serialize($assoc_args));

        \WP_CLI::confirm('BE CAREFUL, this cannot be easily undone so please backup your database before proceeding. Are you sure you want to proceed?', $assoc_args);

        $dryrun = \WP_CLI\Utils\get_flag_value($assoc_args, $this->flags->dryrun->name, false);
        $dryrun && \WP_CLI::log("{$fxn}::Dry run, so do not actually make any changes");

        $limit = \WP_CLI\Utils\get_flag_value($assoc_args, $this->flags->limit->name, 0);
        $limit && \WP_CLI::log("{$fxn}::Limiting to {$limit} tables");

        $results = $this->move_folders($this->get_orphan_folders(), $limit, $dryrun);

        \WP_CLI::success("Processed " . ($results->changed + $results->failed) . " folders: Changed={$results->changed}; Failed={$results->failed}");
        return $results;
    }

    //==========================================================================
    // Methods specific to this class.
    //==========================================================================

    /**
     * Create SQL drop statements for each of the list of table names.
     *
     * @param array $tablenames Array of table names to create drop statements for, each name including the DB prefix.
     * @return array List of SQL drop statements.
     */
    private function create_drop_statements(array $tablenames) {
        $returnThis = [];
        $sql = '';
        foreach ($tablenames as &$t) {
            $sql = "DROP TABLE IF EXISTS {$t};";
            $returnThis[] = $sql;
        }
        return $returnThis;
    }

    /**
     * Execute the list of passed-in SQL statements.
     * E.g. To rename each of the tables passed in with a standard label + hashed table name.
     *
     * @param array $statements SQL RENAME TABLE commands e.g. from list_already_renamed_tables().
     * @param int $limit Only attempt rename on this number of tables (when sorted alphabetically ASC).
     * @param bool $dryrun True to not actually run the queries, just print them.
     * @return \stdClass Result tallies {changed=><int>, failed=><int>}
     */
    private function execute_ddl(array $statements, int $limit = 0, bool $dryrun = false): \stdClass {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        \WP_CLI::debug("{$fxn}::Started with " . \count($statements) . " statements; \$limit={$limit}; \$dryrun={$dryrun}");

        $dryrun && \WP_CLI::log("{$fxn}::Dry run, so do not actually make any changes");
        $limit && \WP_CLI::log("{$fxn}::Limiting to {$limit} tables");

        $returnThis = (object) ['changed' => 0, 'failed' => 0];
        if (empty($statements) || $limit < 0) {
            \WP_CLI::log("{$fxn}::No statements or invalid limit");
            return $returnThis;
        }

        if ($limit > 0) {
            $tables = \array_slice($statements, 0, $limit);
            \WP_CLI::debug("{$fxn}::Cut statements down to " . \count($tables) . ' $statements');
        } else {
            $tables = $statements;
        }

        $result = false;
        foreach ($tables as &$t) {
            //\WP_CLI::debug("{$fxn}::Looking at \$i={$t}");

            if ($dryrun) {
                $result = $this->db->query($t);
            }
            // Table renames do not return a success result.
            if ($dryrun || \stripos($t, 'RENAME TABLE ') !== false || $result) {
                $returnThis->changed++;
                \WP_CLI::success("{$fxn}::\$i={$t}");
            } else {
                $returnThis->failed++;
                \WP_CLI::warning("{$fxn}::\$i={$t}");
            }
            //\WP_CLI::debug("{$fxn}::Got \$result=" . \print_r($result, true));
        }

        return $returnThis;
    }

    /**
     * Get a list of orphaned tables renamed by this package. Renamed tables do not show up as orphaned tables.
     *
     * @return array List of DB table names that have been renamed by this tool.
     */
    private function get_renamed_tables(): array {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        \WP_CLI::debug("{$fxn}::Started");

        $sql = 'SELECT table_name '
                . 'FROM information_schema.tables '
                . "WHERE table_schema='{$this->db->dbname}' "
                . "AND table_name LIKE '{$this->db->prefix}{$this->rename_label}%' "
                . 'ORDER BY table_name';
        \WP_CLI::debug("{$fxn}::About to run sql={$sql}");

        return $this->db->get_col($sql);
    }

    /**
     * Get a list of integers representing existing Multisite blog ids from the prefix_blogs table->blog_id field.
     *
     * @return array See the description.
     */
    private function get_existing_blog_ids(): array {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);

        $existing_blog_ids = $this->db->get_col("SELECT blog_id FROM {$this->db->blogs} ORDER BY blog_id");
        \WP_CLI::debug("{$fxn}::Found " . \count($existing_blog_ids) . " existing_blog_ids=\n" . implode("\n", $existing_blog_ids));
        return $existing_blog_ids;
    }

    /**
     * Get a list of child site table names in the database schema including the prefix. These are tables like prefix_<int>_<name> e.g. wp_22_options for blog_id=22.
     *
     * @return array See the description.
     */
    private function get_child_tablenames() {
        $sql = 'SELECT table_name '
                . 'FROM information_schema.tables '
                . "WHERE table_schema='{$this->db->dbname}' "
                /* Restricting to 0-9 skips tables for the network-level */
                . "AND table_name REGEXP '{$this->db->prefix}[0-9]+_' "
                . 'ORDER BY table_name';
        //\WP_CLI::debug("{$fxn}::About to run sql={$sql}");
        return $this->db->get_col($sql);
    }

    /**
     * Get a list of tables that do not belong to a WP blog. Renamed tables do not show up as orphaned tables.
     *
     * @return array List of DB table names that do not have a matching entry in the WP Multisite wp_blogs table.
     */
    private function get_orphan_tables(): array {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        \WP_CLI::debug("{$fxn}::Started");

        $child_tablenames = $this->get_child_tablenames();
        \WP_CLI::debug("{$fxn}::Found " . \count($child_tablenames) . ' tables');

        //These  blogs_ids represent actual Multisite child blogs we want to keep.
        $existing_blog_ids = $this->get_existing_blog_ids();
        \WP_CLI::debug("{$fxn}::Found " . \count($existing_blog_ids) . " \$existing_blog_ids");

        //Gather the orphaned table names here.
        $orphan_tablenames = [];

        //Search tables with name prefix containing non-existing blog IDs.
        $table_blog_id = 0;
        foreach ($child_tablenames as &$t) {
            \WP_CLI::debug("{$fxn}::Looking at \$table_name={$t}");
            $table_blog_id = $this->get_number_from_table_name($t);
            \WP_CLI::debug("{$fxn}::From \$i={$t} extracted \$table_blog_id={$table_blog_id}");
            if (empty($table_blog_id)) {
                \WP_CLI::debug("{$fxn}::The \$i={$t} is not a WP Multisite child site table");
                continue;
            }
            if (!\in_array($table_blog_id, $existing_blog_ids)) {
                \WP_CLI::debug("{$fxn}::Table \$i={$t} does not represent an existing blog");
                $orphan_tablenames[] = $t;
            }
        }

        return $orphan_tablenames;
    }

    /**
     * Get a list of child site folders in wp-content/uploads/sites/<n> and wp-content/blogs.dir/<n> that do not belong to a WP blog.
     *
     * @return array List of DB table names that do not have a matching entry in the WP Multisite wp_blogs table.
     */
    private function get_orphan_folders(): array {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        \WP_CLI::debug("{$fxn}::Started");

        $source_dirs = $this->get_source_dirs();

        //Gather the orphaned folder names here.
        $orphan_folders = [];

        //These  blogs_ids represent actual Multisite child blogs we want to keep.
        $existing_blog_ids = $this->get_existing_blog_ids();
        \WP_CLI::debug("{$fxn}::Found " . \count($existing_blog_ids) . ' $existing_blog_ids');

        $path = null;
        $diritems = null;
        foreach ($source_dirs as &$s) {
            \WP_CLI::debug("{$fxn}::Looking at upload dir={$s}");
            //Get list of subfolders below th
            $diritems = \scandir($s);
            foreach ($diritems as &$i) {
                $is_dir = \is_dir($path = $s . DIRECTORY_SEPARATOR . $i);
                \WP_CLI::debug("{$fxn}::Looking at subfolder={$i}; in_array(\$existing_blog_ids)=" . \in_array($i, $existing_blog_ids) . "\is_dir({$s} . DIRECTORY_SEPARATOR . {$i})={$is_dir}");
                if (\is_numeric($i) && $is_dir && !\in_array($i, $existing_blog_ids)) {
                    \WP_CLI::debug("{$fxn}::Folder={$path} does not represent an existing blog");
                    $orphan_folders[] = $path;
                }
            }
        }

        return $orphan_folders;
    }

    /**
     * Execute the list of passed-in SQL statements.
     * E.g. To rename each of the tables passed in with a standard label + hashed table name.
     *
     * @param array $folders Full paths of files/folders to move.
     * @param int $limit Only attempt rename on this number of tables (when sorted alphabetically ASC).
     * @param bool $dryrun True to not actually run the queries, just print them.
     * @return \stdClass Result tallies {changed=><int>, failed=><int>}
     */
    private function move_folders(array $folders, int $limit = 0, bool $dryrun = false): \stdClass {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        \WP_CLI::debug("{$fxn}::Started with " . \count($folders) . " folders; \$limit={$limit}; \$dryrun={$dryrun}");

        $dryrun && \WP_CLI::log("{$fxn}::Dry run, so do not actually make any changes");
        $limit && \WP_CLI::log("{$fxn}::Limiting to {$limit} tables");

        $returnThis = (object) ['changed' => 0, 'failed' => 0];
        if (empty($folders) || $limit < 0) {
            \WP_CLI::log("{$fxn}::No folders found or invalid limit");
            return $returnThis;
        }

        if ($limit > 0) {
            $orphaned_folder = \array_slice($folders, 0, $limit);
            \WP_CLI::debug("{$fxn}::Cut \$orphaned_folder folders list down to " . \count($orphaned_folder) . ' entries');
        } else {
            $orphaned_folder = $folders;
        }

        // Where to put all the moved folders.
        $target_basedir = $this->get_target_dir();
        \WP_CLI::debug("{$fxn}::Built \$target_basedir={$target_basedir}");

        if (!$this->dir_present_writable($target_basedir)) {
            \WP_CLI::error("{$fxn}::The folder {$target_basedir} could not be created");
        }
        \WP_CLI::success("{$fxn}::Made sure folder exists: {$target_basedir}");

        //Prevent web access to this dir.
        $htaccess_location = $target_basedir . DIRECTORY_SEPARATOR . '.htaccess';
        if (!\file_exists($htaccess_location)) {
            $htaccess_content = <<<EOF
<IfModule mod_authz_core.c>
    Require all denied
</IfModule>
<IfModule !mod_authz_core.c>
    Order deny,allow
    Deny from all
</IfModule>
EOF;
            $success = \file_put_contents($htaccess_location, $htaccess_content);
            if (!$success) {
                \WP_CLI::error("{$fxn}::Failed to create .htaccess file in {$htaccess_location}");
            }
        }

        $result = false;
        $wpuploadsdir = $this->get_wpuploads_dir();
        foreach ($orphaned_folder as &$this_orhaneddir) {
            \WP_CLI::debug("{$fxn}::Looking at \$this_sourcedir={$this_orhaneddir}");

            switch (true) {
                case (\realpath($this_orhaneddir) == \realpath($wpuploadsdir)):
                    //The path must not be the wp_uploads folder itself.
                    \WP_CLI::warning("{$fxn}::Skipping invalid request to move the wp uploads folder itself");
                    continue 2;
                case(!$this->is_subdir_of($this_orhaneddir, $wpuploadsdir)):
                    //Security: The orphaned folder path must be under the WP uploads dir.
                    $returnThis->failed++;
                    \WP_CLI::warning("{$fxn}::Skipping invalid request to move file bc its parent dir " . dirname($this_orhaneddir) . " is not under the wp uploads folder={$wpuploadsdir}");
                    continue 2;
            }

            //Build the target location relative to the target base dir.
            $target_dir = $this->get_sourcedir_in_targetdir($this_orhaneddir);
            \WP_CLI::debug("{$fxn}::Built \:Built $target_dir={$target_dir}");

            //Re-create the sourcedir parent folder structure in the target dir.
            $target_dir_parent = dirname($target_dir);
            if (!$dryrun && !$this->dir_present_writable($target_dir_parent)) {
                \WP_CLI::error("{$fxn}::The folder {$target_basedir} could not be created");
            }
            \WP_CLI::success("{$fxn}::Make sure the folder exists: {$target_dir_parent}");

            //Security: The final built destination path must be under the $target_new_basedir path.
            if (!$this->is_subdir_of($target_dir, $target_basedir, false)) {
                \WP_CLI::warning("{$fxn}::Skipping invalid request to move file bc its destination={$target_dir} is not under the target package-labelled folder={$target_basedir}");
                $returnThis->failed++;
                continue;
            }

            //Move the folders.
            if (!$dryrun) {
                $result = rename($this_orhaneddir, $target_dir);
            }
            if ($dryrun || $result) {
                $returnThis->changed++;
                \WP_CLI::success("{$fxn}::Moved {$this_orhaneddir} to {$target_dir}");
            } else {
                $returnThis->failed++;
                \WP_CLI::warning("{$fxn}::Failed to move {$this_orhaneddir} to {$target_dir}");
            }
            //\WP_CLI::debug("{$fxn}::Got \$result=" . \print_r($result, true));
        }
        return $returnThis;
    }

    /**
     * Get a list of folders that were moved by this package.
     *
     * @return array List of DB table names that do not have a matching entry in the WP Multisite wp_blogs table.
     */
    private function get_moved_folders(): array {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        \WP_CLI::debug("{$fxn}::Started");

        $orphan_folders = [];
        $targetdir = $this->get_target_dir();
        \WP_CLI::debug("{$fxn}::Got \$targetdir={$targetdir}");

        foreach ($this->get_source_dirs() as $this_sourcedir) {
            //Get path inside $targetdir that represent each $source_dir.
            $possible_targetdir = $this->get_sourcedir_in_targetdir($this_sourcedir);
            \WP_CLI::debug("{$fxn}::Looking for moved folders in parent folder={$possible_targetdir}");

            $diritems = \scandir($possible_targetdir);
            foreach ($diritems as &$this_dirname) {
                \WP_CLI::debug("{$fxn}::Looking at folder={$this_dirname}");
                $possible_target_fullpath=$possible_targetdir . DIRECTORY_SEPARATOR . $this_dirname;
                if (is_numeric($this_dirname) && \is_dir($possible_target_fullpath)) {
                    \WP_CLI::debug("{$fxn}::Found moved folder={$possible_target_fullpath}");
                    $orphan_folders[] = $possible_target_fullpath;
                }
            }
        }

        \WP_CLI::debug("{$fxn}::About to return \$orphan_folders=".print_r($orphan_folders, true));
        return $orphan_folders;
    }

    private function get_source_dirs(): array {
        $wpuploadsdir = $this->get_wpuploads_dir();
        if (empty($this->source_dirs)) {
            $this->source_dirs = [$wpuploadsdir, $wpuploadsdir . DIRECTORY_SEPARATOR . 'sites'];
        }
        return $this->source_dirs;
    }

    private function get_target_dir() {
        if (empty($this->target_dir)) {
            $this->target_dir = $this->get_wpuploads_dir() . DIRECTORY_SEPARATOR . $this->rename_label;
        }
        return $this->target_dir;
    }

    private function get_sourcedir_in_targetdir(string $sourcedir): string {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        $relative_path = $this->get_path_relative_to_uploads($sourcedir);
        \WP_CLI::debug("{$fxn}::Got \$relative_path={$relative_path}");
        // We never want a trailing slash, so if $relative path is empty, remove the trailing slash.
        return rtrim($this->get_target_dir() . DIRECTORY_SEPARATOR . $relative_path, DIRECTORY_SEPARATOR);
    }

    //==========================================================================
    // Utility methods specific to WordPress
    //==========================================================================
    private function get_wpuploads_dir(): string {
        if (empty($this->wpuploadsdir)) {
            $this->wpuploadsdir = \wp_upload_dir()['basedir'];
        }
        return $this->wpuploadsdir;
    }

    private function get_path_relative_to_uploads(string $folder): string {
        // We never want a leading or trailing slash since it it a relative dir.
        return \trim(\str_replace($this->wpuploadsdir, '', $folder), DIRECTORY_SEPARATOR);
    }

    //==========================================================================
    // Utility methods not specific to this class.
    //==========================================================================

    private function dir_present_writable(string $dir_to_check, $perms = 0755, $recursive = false): bool {
        $fxn = \implode('::', [__CLASS__, __FUNCTION__]);
        \WP_CLI::debug("{$fxn}::Started with \$dir_to_check={$dir_to_check}; \$perms={$perms}");

        $success = true;

        if (\is_file($dir_to_check)) {
            \WP_CLI::debug("{$fxn}::is_file=true for \$dir_to_check={$dir_to_check}; \$perms={$perms}");
            throw new InvalidArgumentException("Cannot create a folder overwriting an existing file {$dir_to_check}");
        }
        if (!\is_dir($dir_to_check)) {
            \WP_CLI::debug("{$fxn}::is_dir=false for \$dir_to_check={$dir_to_check}, so try to make it");
            $success = \mkdir($dir_to_check, $perms, $recursive);
            \WP_CLI::debug("{$fxn}::mkdir={$success} for \$dir_to_check={$dir_to_check}");
            if (!$success) {
                return false;
            }
        }
        if (!\is_writable($dir_to_check)) {
            \WP_CLI::debug("{$fxn}::is_writable={$success} for \$dir_to_check={$dir_to_check}, so try to chmod");
            $success = chmod($dir_to_check, $perms);
            \WP_CLI::debug("{$fxn}::chmod={$success} for \$dir_to_check={$dir_to_check}");
        }

        \WP_CLI::debug("{$fxn}::About to return \$success={$success}");
        return $success;
    }

    /**
     * Get the child site number from a WP Multisite DB table name like wp_3682_options.
     * If no such number is found, returns zero 0.
     *
     * @ref https://github.com/shawnhooper/delete-orphaned-multisite-tables/blob/master/wp-cli.php
     * @param type $tablename String DB table name.
     * @return int The child site number, or zero if nothing found.
     */
    private function get_number_from_table_name($tablename): int {
        $noPrefix = \preg_replace('/^' . $this->db->prefix . '/', '', $tablename);
        return (int) \substr($noPrefix, 0, \strpos($noPrefix, '_'));
    }

    /**
     * Check if $dir is a child folder of $parentdir. Does not use realpath.
     * 
     * @param string $parentdir
     * @param string $child
     */
    private function is_subdir_of(string $child, string $parentdir, bool $childmustbedir = true): bool {
        $debug = false;
        if ($debug) {
            echo "is_dir({$parentdir})=" . is_dir($parentdir) . "\n";
            echo "is_dir({$child})=" . is_dir($child) . "\n";
            echo "({$childmustbedir} || is_dir({$child}))=" . ($childmustbedir || is_dir($child)) . "\n";
            echo "dirname({$child})=" . dirname($child) . "\n";
            echo "\stripos(dirname({$child}), {$parentdir})!==false" . print_r(\stripos(dirname($child), $parentdir) !== false, true) . "\n";
        }
        return is_dir($parentdir) && (!$childmustbedir || is_dir($child)) &&
                \stripos(dirname($child), $parentdir) !== false;
    }

}

\WP_CLI::add_command('wp-multisite-orphans', __NAMESPACE__ . '\\WP_Multisite_Orphans');