utils/delete-empty-volume-folders command

Resolves #16388

CHANGELOG-WIP.md

@@ -4,6 +4,7 @@
 - The global sidebar no longer shows “Failed” for queue jobs, for users that don’t have access to the Queue Manager. ([#16184](https://github.com/craftcms/cms/issues/16184))
 
 ## Administration
+- Added the `utils/delete-empty-volume-folders` command. ([#16388](https://github.com/craftcms/cms/issues/16388))
 - The Queue Manager utility now shows jobs’ class names. ([#16228](https://github.com/craftcms/cms/pull/16228)) 
 
 ## Development

src/console/controllers/utils/DeleteEmptyVolumeFoldersController.php

@@ -0,0 +1,90 @@
+<?php
+/**
+ * @link https://craftcms.com/
+ * @copyright Copyright (c) Pixel & Tonic, Inc.
+ * @license https://craftcms.github.io/license/
+ */
+
+namespace craft\console\controllers\utils;
+
+use Craft;
+use craft\console\Controller;
+use craft\db\Query;
+use craft\db\Table;
+use yii\console\ExitCode;
+
+/**
+ * Deletes empty volume folders.
+ *
+ * @author Pixel & Tonic, Inc. <[email protected]>
+ * @since 4.14.0
+ */
+class DeleteEmptyVolumeFoldersController extends Controller
+{
+    /**
+     * @var string|null The volume handle(s) to delete folders from. Can be set to multiple comma-separated volumes.
+     */
+    public ?string $volume = null;
+
+    /**
+     * @inheritdoc
+     */
+    public function options($actionID): array
+    {
+        return [
+            ...parent::options($actionID),
+            'volume',
+        ];
+    }
+
+    /**
+     * Deletes empty volume folders.
+     *
+     * @return int
+     */
+    public function actionIndex(): int
+    {
+        $query = (new Query())
+            ->select(['folders.id'])
+            ->from(['folders' => Table::VOLUMEFOLDERS])
+            ->leftJoin(['assets' => Table::ASSETS], '[[assets.folderId]] = [[folders.id]]')
+            ->where(['assets.id' => null])
+            ->andWhere(['not', ['folders.parentId' => null]])
+            ->andWhere(['not', ['folders.path' => null]]);
+
+        if ($this->volume) {
+            $volumeHandles = explode(',', $this->volume);
+            $volumeIds = [];
+            $volumesService = Craft::$app->getVolumes();
+            foreach ($volumeHandles as $handle) {
+                $volume = $volumesService->getVolumeByHandle($handle);
+                if (!$volume) {
+                    $this->stderr("Invalid volume handle: $handle\n");
+                    return ExitCode::UNSPECIFIED_ERROR;
+                }
+                $volumeIds[] = $volume->id;
+            }
+
+            $query->andWhere(['folders.volumeId' => $volumeIds]);
+        }
+
+        $emptyFolderIds = $query->column();
+
+        if (empty($emptyFolderIds)) {
+            $this->stdout("No empty folders found.\n");
+            return ExitCode::OK;
+        }
+
+        $message = sprintf(
+            'Deleting %s empty %s',
+            count($emptyFolderIds),
+            count($emptyFolderIds) === 1 ? 'folder' : 'folders',
+        );
+
+        $this->do($message, function() use ($emptyFolderIds) {
+            Craft::$app->getAssets()->deleteFoldersByIds($emptyFolderIds);
+        });
+
+        return ExitCode::OK;
+    }
+}