[Task][Application Logger] Remove PIMCORE_LOG_FILEOBJECT_DIRECTORY (p…

…imcore#15175) * Removed PIMCORE_LOG_FILEOBJECT_DIRECTORY constant, adapted code * Update bundles/ApplicationLoggerBundle/src/Controller/LogController.php Co-authored-by: lukmzig <[email protected]> --------- Co-authored-by: lukmzig <[email protected]>
elevantiq · May 11, 2023 · 944ca73 · 944ca73
1 parent 1c83754
commit 944ca73
Show file tree

Hide file tree

Showing 7 changed files with 6 additions and 59 deletions.
diff --git a/bundles/ApplicationLoggerBundle/config/pimcore/config.yaml b/bundles/ApplicationLoggerBundle/config/pimcore/config.yaml
@@ -5,5 +5,4 @@ flysystem:
             adapter: 'local'
             visibility: private
             options:
-                # TODO: revert default to `var/application-logger` when PIMCORE_LOG_FILEOBJECT_DIRECTORY is deprecated
-                directory: "%log.fileobject%"
+                directory: "%kernel.project_dir%/var/application-logger"
diff --git a/bundles/ApplicationLoggerBundle/src/Controller/LogController.php b/bundles/ApplicationLoggerBundle/src/Controller/LogController.php
@@ -24,6 +24,7 @@
 use Pimcore\Controller\Traits\JsonHelperTrait;
 use Pimcore\Controller\UserAwareController;
 use Pimcore\Tool\Storage;
+use Symfony\Component\Filesystem\Exception\FileNotFoundException;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -219,14 +220,8 @@ public function componentJsonAction(Request $request): JsonResponse
 
     /**
      * @Route("/log/show-file-object", name="pimcore_admin_bundle_applicationlogger_log_showfileobject", methods={"GET"})
-     *
-     * @param Request $request
-     *
-     * @return StreamedResponse|Response
-     *
-     * @throws \Exception
      */
-    public function showFileObjectAction(Request $request): StreamedResponse|Response
+    public function showFileObjectAction(Request $request): StreamedResponse
     {
         $this->checkPermission('application_logging');
 
@@ -241,40 +236,10 @@ static function () use ($fileData) {
                 }
             );
             $response->headers->set('Content-Type', 'text/plain');
-        } else {
-            // Fallback to local path when file is not found in flysystem that might still be using the constant
-
-            if (!filter_var($filePath, FILTER_VALIDATE_URL)) {
-                if (!file_exists($filePath)) {
-                    $filePath = PIMCORE_PROJECT_ROOT.DIRECTORY_SEPARATOR.$filePath;
-                }
-                $filePath = realpath($filePath);
-                $fileObjectPath = realpath(PIMCORE_LOG_FILEOBJECT_DIRECTORY);
-            } else {
-                $fileObjectPath = PIMCORE_LOG_FILEOBJECT_DIRECTORY;
-            }
-
-            if (!str_starts_with($filePath, $fileObjectPath)) {
-                throw new AccessDeniedHttpException('Accessing file out of scope');
-            }
 
-            if (file_exists($filePath)) {
-                $response = new StreamedResponse(
-                    static function () use ($filePath) {
-                        $handle = fopen($filePath, 'rb');
-                        fpassthru($handle);
-                        fclose($handle);
-                    }
-                );
-                $response->headers->set('Content-Type', 'text/plain');
-            } else {
-                $response = new Response();
-                $response->headers->set('Content-Type', 'text/plain');
-                $response->setContent('Path `'.$filePath.'` not found.');
-                $response->setStatusCode(404);
-            }
+            return $response;
         }
 
-        return $response;
+        throw new FileNotFoundException($filePath);
     }
 }
diff --git a/bundles/ApplicationLoggerBundle/src/Maintenance/LogArchiveTask.php b/bundles/ApplicationLoggerBundle/src/Maintenance/LogArchiveTask.php
@@ -89,12 +89,6 @@ public function execute(): void
                 if ($filePath !== null) {
                     if ($storage->fileExists($filePath)) {
                         $storage->delete($filePath);
-                    } else {
-                        // Fallback, if is not found and deleted in the flysystem, tries to delete from local
-                        $fileRealPath = realpath($filePath);
-                        if (str_starts_with(realpath($fileRealPath), PIMCORE_LOG_FILEOBJECT_DIRECTORY)) {
-                            @unlink($fileRealPath);
-                        }
                     }
                 }
             }
@@ -121,12 +115,6 @@ public function execute(): void
 
                 if ($storage->directoryExists($folderName)) {
                     $storage->deleteDirectory($folderName);
-                } else {
-                    // Fallback, if is not found and deleted in the flysystem, tries to delete from local
-                    $folderRealPath = realpath(PIMCORE_LOG_FILEOBJECT_DIRECTORY . DIRECTORY_SEPARATOR . $folderName);
-                    if (str_starts_with(realpath($folderRealPath), PIMCORE_LOG_FILEOBJECT_DIRECTORY)) {
-                        @unlink($folderRealPath);
-                    }
                 }
             }
 

diff --git a/bundles/CoreBundle/config/pimcore/flysystem.yaml b/bundles/CoreBundle/config/pimcore/flysystem.yaml
@@ -1,7 +1,3 @@
-parameters:
-    # TODO: remove this BC layer in 11 or as soon as PIMCORE_LOG_FILEOBJECT_DIRECTORY is deprecated
-    log.fileobject: !php/const PIMCORE_LOG_FILEOBJECT_DIRECTORY
-
 flysystem:
     storages:
         pimcore.document_static.storage:

diff --git a/doc/23_Installation_and_Upgrade/09_Upgrade_Notes/README.md b/doc/23_Installation_and_Upgrade/09_Upgrade_Notes/README.md
@@ -490,6 +490,7 @@ pimcore_seo:
 ## Tools
 #### [Application Logger] :
 
+-  Removed deprecated `PIMCORE_LOG_FILEOBJECT_DIRECTORY` constant, since flysystem is used to save/get fileobjects. Please make sure to adapt your code and migrate your fileobjects manually.
 -  Table names of archive tables are now named with year-month rather than month-year see [#8237](https://github.com/pimcore/pimcore/issues/8237).
 
 

diff --git a/lib/Bootstrap.php b/lib/Bootstrap.php
@@ -173,7 +173,6 @@ public static function defineConstants(): void
         $resolveConstant('PIMCORE_CONFIGURATION_DIRECTORY', PIMCORE_PRIVATE_VAR . '/config');
         $resolveConstant('PIMCORE_LOG_DIRECTORY', PIMCORE_PRIVATE_VAR . '/log');
         $resolveConstant('PIMCORE_CACHE_DIRECTORY', PIMCORE_PRIVATE_VAR . '/cache/pimcore');
-        $resolveConstant('PIMCORE_LOG_FILEOBJECT_DIRECTORY', PIMCORE_PRIVATE_VAR . '/application-logger');
         $resolveConstant('PIMCORE_SYMFONY_CACHE_DIRECTORY', PIMCORE_PRIVATE_VAR . '/cache');
         $resolveConstant('PIMCORE_CLASS_DIRECTORY', PIMCORE_PRIVATE_VAR . '/classes');
         $resolveConstant('PIMCORE_CLASS_DEFINITION_DIRECTORY', PIMCORE_CLASS_DIRECTORY);

diff --git a/stubs/dynamic-constants.php b/stubs/dynamic-constants.php
@@ -14,7 +14,6 @@
 define('PIMCORE_CONFIGURATION_DIRECTORY', '');
 define('PIMCORE_LOG_DIRECTORY', '');
 define('PIMCORE_CACHE_DIRECTORY', '');
-define('PIMCORE_LOG_FILEOBJECT_DIRECTORY', '');
 define('PIMCORE_SYSTEM_TEMP_DIRECTORY', '');
 define('PIMCORE_PROJECT_ROOT', '');
 define('PIMCORE_SYMFONY_CACHE_DIRECTORY', '');