Add shopware file checker, fixes #23

Author: shyim

src/Controller/ShopwareFilesController.php

@@ -0,0 +1,78 @@
+<?php
+
+namespace Frosh\Tools\Controller;
+
+use Shopware\Core\Framework\Routing\Annotation\RouteScope;
+use Shopware\Core\Kernel;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\Routing\Annotation\Route;
+
+/**
+ * @RouteScope(scopes={"api"})
+ * @Route(path="/api/_action/frosh-tools")
+ */
+class ShopwareFilesController
+{
+    private string $shopwareVersion;
+
+    private string $projectDir;
+
+    public function __construct(string $shopwareVersion, string $projectDir)
+    {
+        $this->shopwareVersion = $shopwareVersion;
+        $this->projectDir = $projectDir;
+    }
+
+    /**
+     * @Route(path="/shopware-files", methods={"GET"}, name="api.frosh.tools.shopware-files")
+     */
+    public function listShopwareFiles(): JsonResponse
+    {
+        if ($this->shopwareVersion === Kernel::SHOPWARE_FALLBACK_VERSION) {
+            return new JsonResponse(['error' => 'Git version is not supported']);
+        }
+
+        if (!file_exists($this->projectDir . '/vendor/shopware/core')) {
+            return new JsonResponse(['error' => 'Works only in Production template']);
+        }
+
+        $url = sprintf('https://swagger.docs.fos.gg/version/%s/Files.md5sums', $this->shopwareVersion);
+
+        $data = trim(@file_get_contents($url));
+
+        if (empty($data)) {
+            return new JsonResponse(['error' => 'No file information for this Shopware version']);
+        }
+
+        $invalidFiles = [];
+
+        foreach (explode("\n", $data) as $row) {
+            [$expectedMd5Sum, $file] = explode('  ', trim($row));
+            $fileAvailable = is_file($this->projectDir . $file);
+
+            if ($fileAvailable) {
+                $md5Sum = md5_file($this->projectDir . $file);
+
+                // This file differs on update systems. This change is missing in update packages lol!
+                // @see: https://github.com/shopware/platform/commit/957e605c96feef67a6c759f00c58e35d2d1ac84f#diff-e49288a50f0d7d8acdabb5ffef2edcd5ac4f4126f764d3153d19913ce98aba1cL10-R80
+                // @see: https://issues.shopware.com/issues/NEXT-11618
+                if ($file === 'vendor/shopware/core/Checkout/Order/Aggregate/OrderAddress/OrderAddressDefinition.php' && $md5Sum === 'e3da59baff091fd044a12a61cd445385') {
+                    continue;
+                }
+
+                // This file differs on update systems. This change is missing in update packages lol!
+                // @see: https://github.com/shopware/platform/commit/bbdcbe254e3239e92eb1f71a7afedfb94b7fb150
+                // @see: https://issues.shopware.com/issues/NEXT-11775
+                if ($file === 'vendor/shopware/administration/Resources/app/administration/src/app/component/media/sw-media-compact-upload-v2/index.js' && $md5Sum === '74d18e580ffe87559e6501627090efb3') {
+                    continue;
+                }
+
+                if ($md5Sum !== $expectedMd5Sum) {
+                    $invalidFiles[] = ['name' => $file];
+                }
+            }
+        }
+
+        return new JsonResponse(['ok' => empty($invalidFiles), 'files' => $invalidFiles]);
+    }
+}

src/Resources/app/administration/src/api/frosh-tools.js

@@ -94,6 +94,18 @@ class FroshTools extends ApiService {
             return response;
         });
     }
+
+    getShopwareFiles() {
+        const apiRoute = `${this.getApiBasePath()}/shopware-files`;
+        return this.httpClient.get(
+            apiRoute,
+            {
+                headers: this.getBasicHeaders()
+            }
+        ).then((response) => {
+            return response;
+        });
+    }
 }
 
 export default FroshTools;

src/Resources/app/administration/src/module/frosh-tools/component/frosh-tools-tab-files/index.js

@@ -0,0 +1,42 @@
+import template from './template.twig';
+
+const { Component, Mixin } = Shopware;
+
+Component.register('frosh-tools-tab-files', {
+    template,
+    inject: ['repositoryFactory', 'FroshToolsService'],
+    mixins: [
+        Mixin.getByName('notification')
+    ],
+
+    data() {
+        return {
+            items: {},
+            isLoading: true
+        };
+    },
+
+    created() {
+        this.createdComponent();
+    },
+
+    computed: {
+        columns() {
+            return [
+                {
+                    property: 'name',
+                    label: 'frosh-tools.name',
+                    rawData: true,
+                    primary: true
+                }
+            ];
+        }
+    },
+
+    methods: {
+        async createdComponent() {
+            this.items = (await this.FroshToolsService.getShopwareFiles()).data;
+            this.isLoading = false;
+        }
+    }
+});

src/Resources/app/administration/src/module/frosh-tools/component/frosh-tools-tab-files/template.twig

@@ -0,0 +1,14 @@
+<sw-card-view>
+    <sw-card :title="$tc('frosh-tools.tabs.files.title')" :isLoading="isLoading" :large="true">
+        <sw-alert variant="error" v-if="items.error">{{ items.error }}</sw-alert>
+
+        <sw-alert variant="success" v-if="items.ok">All files are not modified</sw-alert>
+
+        <sw-data-grid
+            v-if="items.files"
+            :showSelection="false"
+            :dataSource="items.files"
+            :columns="columns">
+        </sw-data-grid>
+    </sw-card>
+</sw-card-view>

src/Resources/app/administration/src/module/frosh-tools/index.js

@@ -4,6 +4,7 @@ import './component/frosh-tools-tab-queue';
 import './component/frosh-tools-tab-scheduled';
 import './component/frosh-tools-tab-elasticsearch';
 import './component/frosh-tools-tab-logs';
+import './component/frosh-tools-tab-files';
 import './page/index';
 
 Shopware.Module.register('frosh-tools', {
@@ -62,6 +63,13 @@ Shopware.Module.register('frosh-tools', {
                         parentPath: 'frosh.tools.index'
                     }
                 },
+                files: {
+                    component: 'frosh-tools-tab-files',
+                    path: 'files',
+                    meta: {
+                        parentPath: 'frosh.tools.index'
+                    }
+                },
             }
         },
     },

src/Resources/app/administration/src/module/frosh-tools/page/index/template.twig

@@ -26,6 +26,10 @@
                     {{ $tc('frosh-tools.tabs.logs.title') }}
                 </sw-tabs-item>
 
+                <sw-tabs-item :route="{ name: 'frosh.tools.index.files' }">
+                    {{ $tc('frosh-tools.tabs.files.title') }}
+                </sw-tabs-item>
+
 {#                <sw-tabs-item :route="{ name: 'frosh.tools.index.elasticsearch' }">#}
 {#                    {{ $tc('frosh-tools.tabs.elasticsearch.title') }}#}
 {#                </sw-tabs-item>#}

src/Resources/app/administration/src/module/frosh-tools/snippet/de-DE.json

@@ -22,6 +22,9 @@
       },
       "logs": {
         "title": "Log viewer"
+      },
+      "files": {
+        "title": "Shopware Dateien Checker"
       }
     },
     "clear": "Leeren",

src/Resources/app/administration/src/module/frosh-tools/snippet/en-GB.json

@@ -22,6 +22,9 @@
       },
       "logs": {
         "title": "Log viewer"
+      },
+      "files": {
+        "title": "Shopware file checker"
       }
     },
     "clear": "Clear",

src/Resources/config/services.xml

@@ -92,5 +92,10 @@
             <argument>task_logging</argument>
             <argument>14</argument>
         </service>
+
+        <service id="Frosh\Tools\Controller\ShopwareFilesController" public="true">
+            <argument>%kernel.shopware_version%</argument>
+            <argument>%kernel.project_dir%</argument>
+        </service>
     </services>
 </container>