SyncViaHttpCommands.php

<?php

namespace Drush\Commands;

use Consolidation\AnnotatedCommand\CommandData;
use Consolidation\AnnotatedCommand\Hooks\HookManager;
use Drush\Attributes as CLI;
use Drush\Commands\DrushCommands;
use Drush\Commands\sql\SqlSyncCommands;
use Drush\Drush;
use Drush\Exec\ExecTrait;
use Symfony\Component\Filesystem\Filesystem;

/**
 * Load this commandfile using the --include option - e.g. `drush --include=/path/to/drush/examples`
 */

class SyncViaHttpCommands extends DrushCommands
{
  /**
   * When a hook extends a command with additional options, it must
   * implement declare those option(s) in a @hook option like this one.  Doing so will add
   * the option to the help text for the modified command, and will also
   * allow the new option to be specified on the command line.  Without
   * this, Drush will fail with an error when a user attempts to use
   * an unknown option.
   */
    #[CLI\Hook(type: HookManager::OPTION_HOOK, target: SqlSyncCommands::SYNC)]
    #[CLI\Option(name: 'http-sync', description: 'Copy the database via http instead of rsync.  Value is the url that the existing database dump can be found at.')]
    #[CLI\Option(name: 'http-sync-user', description: 'Username for the protected directory containing the sql dump.')]
    #[CLI\Option(name: 'http-sync-password', description: 'Password for the same directory.')]
    public function optionsetSqlSync()
    {
    }

    /**
     * During the pre hook, determine if the http-sync option has been
     * specified.  If it has been, then disable the normal ssh + rsync
     * dump-and-transfer that sql-sync usually does, and transfer the
     * database dump via an http download.
     */
    #[CLI\Hook(type: HookManager::PRE_COMMAND_HOOK, target: SqlSyncCommands::SYNC)]
    public function preSqlSync(CommandData $commandData)
    {
        $sql_dump_download_url = $commandData->input()->getOption('http-sync');
        if (!empty($sql_dump_download_url)) {
            $user = $commandData->input()->getOption('http-sync-user');
            $password = $commandData->input()->getOption('http-sync-password');
            $source_dump_file = $this->downloadFile($sql_dump_download_url, $user, $password);
            $commandData->input()->setOption('target-dump', $source_dump_file);
            $commandData->input()->setOption('no-dump', true);
            $commandData->input()->setOption('no-sync', true);
        }
    }

    /**
     * Downloads a file.
     *
     * Optionally uses user authentication, using either wget or curl, as available.
     */
    protected function downloadFile($url, $user = false, $password = false, $destination = false, $overwrite = true)
    {
        static $use_wget;
        if ($use_wget === null) {
            $use_wget = ExecTrait::programExists('wget');
        }

        $destination_tmp = drush_tempnam('download_file');
        if ($use_wget) {
            $args = ['wget', '-q', '--timeout=30'];
            if ($user && $password) {
                $args = array_merge($args, ["--user=$user", "--password=$password", '-O', $destination_tmp, $url]);
            } else {
                $args = array_merge($args, ['-O', $destination_tmp, $url]);
            }
        } else {
            $args = ['curl', '-s', '-L', '--connect-timeout 30'];
            if ($user && $password) {
                $args = array_merge($args, ['--user', "$user:$password", '-o', $destination_tmp, $url]);
            } else {
                $args = array_merge($args, ['-o', $destination_tmp, $url]);
            }
        }
        $process = Drush::process($args);
        $process->mustRun();

        if (!Drush::simulate()) {
            if (!drush_file_not_empty($destination_tmp) && $file = @file_get_contents($url)) {
                @file_put_contents($destination_tmp, $file);
            }
            if (!drush_file_not_empty($destination_tmp)) {
                // Download failed.
                throw new \Exception(dt("The URL !url could not be downloaded.", ['!url' => $url]));
            }
        }
        if ($destination) {
            $fs = new Filesystem();
            $fs->rename($destination_tmp, $destination, $overwrite);
            return $destination;
        }
        return $destination_tmp;
    }
}

---

Last update: March 15, 2023

Authors: Greg Anderson, Moshe Weitzman