[CustomerNamingScheme] add cleanup job for empty directories

Author: markus-moser

src/CustomerProvider/ObjectNamingScheme/DefaultObjectNamingScheme.php

@@ -11,12 +11,18 @@
 
 namespace CustomerManagementFrameworkBundle\CustomerProvider\ObjectNamingScheme;
 
+use CustomerManagementFrameworkBundle\Config;
 use CustomerManagementFrameworkBundle\Helper\Objects;
 use CustomerManagementFrameworkBundle\Model\CustomerInterface;
+use CustomerManagementFrameworkBundle\Traits\LoggerAware;
+use Pimcore\Model\Object\Folder;
+use Pimcore\Model\Object\Listing;
 use Pimcore\Model\Object\Service;
 
 class DefaultObjectNamingScheme implements ObjectNamingSchemeInterface
 {
+    use LoggerAware;
+
     /**
      * @param CustomerInterface $customer
      * @param string $parentPath
@@ -46,6 +52,39 @@ public function apply(CustomerInterface $customer, $parentPath, $namingScheme)
         Objects::checkObjectKey($customer);
     }
 
+    public function cleanupEmptyFolders()
+    {
+        $config = Config::getConfig()->CustomerProvider;
+        if(!$config->parentPath) {
+            return;
+        }
+
+        if(!$config->namingScheme) {
+            return;
+        }
+
+        $folders = new Listing;
+
+        // apply it for folders older then 10 minutes only
+        $timestamp = time() - 60*10;
+
+        $folders->setCondition(
+            "o_id in (select o_id from (select o_id, o_path, o_key, o_type, (select count(*) from objects where o_parentId = o.o_id) as counter from objects o) as temp where counter=0 and o_type = 'folder' and o_path like ?  and o_creationDate < ?)",
+            [
+                str_replace('//', '/', $config->parentPath.'/%'),
+                $timestamp
+            ]
+        );
+
+        foreach($folders as $folder) {
+            if($folder instanceof Folder) {
+                $folder->delete();
+                $this->getLogger()->error("delete empty folder ". (string) $folder);
+            }
+        }
+    }
+
+
     private function correctPath($path)
     {
         return str_replace('//', '/', $path);

src/CustomerProvider/ObjectNamingScheme/ObjectNamingSchemeInterface.php

@@ -23,4 +23,11 @@ interface ObjectNamingSchemeInterface
      * @return void
      */
     public function apply(CustomerInterface $customer, $parentPath, $namingScheme);
+
+    /**
+     * deletes empty subfolders of the customers folder
+     *
+     * @return void
+     */
+    public function cleanupEmptyFolders();
 }

src/Event/MaintenanceEventListener.php

@@ -17,5 +17,6 @@ public function onMaintenance(\Pimcore\Event\System\MaintenanceEvent $e)
     {
         \Pimcore::getContainer()->get('cmf.segment_manager')->executeSegmentBuilderMaintenance();
         \Pimcore::getContainer()->get('cmf.customer_exporter_manager')->cleanupExportTmpData();
+        \Pimcore::getContainer()->get('cmf.customer_provider.object_naming_scheme')->cleanupEmptyFolders();
     }
 }

src/Resources/config/services.yml

@@ -100,6 +100,8 @@ services:
     cmf.customer_provider.object_naming_scheme:
          class: CustomerManagementFrameworkBundle\CustomerProvider\ObjectNamingScheme\DefaultObjectNamingScheme
          lazy: true
+         calls:
+            - [setLogger, ['@cmf.logger']]
 
     cmf.action_trigger.queue:
         class: CustomerManagementFrameworkBundle\ActionTrigger\Queue\DefaultQueue