cv dl - Queued downloader does not currently support --to

[circleinteractive]

Hi,

latest cv (0.3.65) says that although 'cv help dl' lists the '--to' switch.

Is it possible to restore the functionality?
it would be handy.

Thanks

[totten]

I went to have a look and realized that --to wasn't work at all (at least, on my laptop in Starbucks) -- a casualty of the Infra-Bot Wars.

#277 should get --to working again in the --bare mode.

In terms of functionality I like the idea of supporting --to in queued-downloader.

Operationally, it's a little trickier. cv is wrapping around core's CRM_Extension_QueueDownloader, which doesn't accept any arguments for the file-destination. Implementing it requires some coordinated-updates. Probably takes several hours, and not sure when I'd get to it.

If you're really keen, here's a sketch of one way to start on the core side:

diff --git a/CRM/Extension/QueueDownloader.php b/CRM/Extension/QueueDownloader.php
index b7228e6fec..08399df9e1 100644
--- a/CRM/Extension/QueueDownloader.php
+++ b/CRM/Extension/QueueDownloader.php
@@ -133,8 +133,8 @@ class CRM_Extension_QueueDownloader {
    *   FALSE if the downloader should only get the files and put them in place
    * @return $this
    */
-  public function addDownloads(array $downloads, bool $autoApply = TRUE) {
-    $this->batches[] = ['type' => 'download', 'urls' => $downloads, 'autoApply' => $autoApply];
+  public function addDownloads(array $downloads, bool $autoApply = TRUE, array $destinations = []) {
+    $this->batches[] = ['type' => 'download', 'urls' => $downloads, 'autoApply' => $autoApply, 'destinations' => $destinations];
     return $this;
   }
 
@@ -187,7 +187,7 @@ class CRM_Extension_QueueDownloader {
           // Swap-in new folders with a single operation. This should be similar to more sophisticated site-builder
           // workflows. (f you manage a site in git, then "git pull" swaps all code at the same time.) This
           // can't guarantee that all combinations of $downloads work, but at least they'll behave consistently.
-          $queue->createItem(static::task(ts('Swap folders'), 'swap', [array_keys($downloads)]));
+          $queue->createItem(static::task(ts('Swap folders'), 'swap', [array_keys($downloads), $batch['destinations'] ?? []]));
 
           // The "swap" and "rebuild" must happen in separate steps.
           if ($batch['autoApply']) {
diff --git a/CRM/Extension/QueueTasks.php b/CRM/Extension/QueueTasks.php
index 03e0eaa2c4..4d056ee1ad 100644
--- a/CRM/Extension/QueueTasks.php
+++ b/CRM/Extension/QueueTasks.php
@@ -85,13 +85,15 @@ class CRM_Extension_QueueTasks {
    * Move any old code to the backup (`stagingDir/old/{key}`).
    * Delete the container-cache
    */
-  public static function swap(CRM_Queue_TaskContext $ctx, string $stagingPath, array $keys): bool {
+  public static function swap(CRM_Queue_TaskContext $ctx, string $stagingPath, array $keys, array $destinations = []): bool {
     CRM_Utils_File::createDir("$stagingPath/old", 'exception');
     try {
       foreach ($keys as $key) {
         $tmpCodeDir = "$stagingPath/new/$key";
         $backupCodeDir = "$stagingPath/old/$key";
 
+        // FIXME: if $destinations[$key] is set, then we need to move it to the custom place instead...
+        // But fair warning - it's up to the caller to choose a place that will take precedence...
         CRM_Extension_System::singleton()->getManager()->replace($tmpCodeDir, $backupCodeDir, FALSE);
         // What happens when you call replace(.., refresh: false)? Varies by type:
         // - For report/search/payment-extensions, it runs the uninstallation/reinstallation routines.