Clear caches script and hook (#2410)

ioigoume · tvdijen · monkeyiq · web-flow · commit e6708e8bfb4e · 2025-04-03T17:08:58.000+10:00
* Clear caches script and hooke

* Use symofony cache:clear for each module and core

* Overrirde CacheClear Symfony Command

* Github Actions: Create the cache directory.

* Fixing simplesamlphp cache directory

* Fixing chmod permissions

* Fix phpcs issues

* Fix indentation

* config.php.dist file

* config.php.dist file

* Fix failing test after adding the config.php file

* Fix failing test after adding the config.php file

* Clear more caches during update.

Clear the symfony cache to make sure that the ssp-clear command can be found

Using the name "clear-cache" for this script also gave the warning
```
 A script named clear-cache would override a Composer command and has been skipped
```

* Update the docs to be more of a strong recommendation

If we are playing with the cache from composer we really want to
encourage the user to setup that var directory the way that symfony
are wanting it to be setup.

* Include .php.dist files in the sniffer

* Revert previous

---------

Co-authored-by: Tim van Dijen &lt;tvdijen@gmail.com&gt;
Co-authored-by: Ben Martin &lt;monkeyiq@users.sourceforge.net&gt;
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
@@ -57,6 +57,12 @@ jobs:
 
       - uses: actions/checkout@v4
 
+      - name: Copy config.php.dist to config.php
+        run: cp config/config.php.dist config/config.php
+
+      - name: Create SimpleSAMLphp cache directory
+        run: sudo mkdir -p /var/cache/simplesamlphp && sudo chmod 777 /var/cache/simplesamlphp
+
       - name: Get composer cache directory
         run: echo COMPOSER_CACHE="$(composer config cache-files-dir)" >> "$GITHUB_ENV"
 
@@ -123,6 +129,12 @@ jobs:
 
       - uses: actions/checkout@v4
 
+      - name: Copy config.php.dist to config.php
+        run: cp config/config.php.dist config/config.php
+
+      - name: Create SimpleSAMLphp cache directory
+        run: sudo mkdir -p /var/cache/simplesamlphp && sudo chmod 777 /var/cache/simplesamlphp
+
       - name: Get composer cache directory
         run: echo COMPOSER_CACHE="$(composer config cache-files-dir)" >> "$GITHUB_ENV"
 
@@ -179,6 +191,12 @@ jobs:
 
       - uses: actions/checkout@v4
 
+      - name: Copy config.php.dist to config.php
+        run: cp config/config.php.dist config/config.php
+
+      - name: Create SimpleSAMLphp cache directory
+        run: sudo mkdir -p /var/cache/simplesamlphp && sudo chmod 777 /var/cache/simplesamlphp
+
       - name: Get composer cache directory
         run: echo COMPOSER_CACHE="$(composer config cache-files-dir)" >> "$GITHUB_ENV"
 
@@ -252,7 +270,7 @@ jobs:
           restore-keys: ${{ runner.os }}-composer-
 
       - name: Install Composer dependencies
-        run: composer install --no-progress --prefer-dist --optimize-autoloader
+        run: composer install --no-progress --prefer-dist --optimize-autoloader --no-scripts
 
       - name: Run unit tests
         run: ./vendor/bin/phpunit --no-coverage
diff --git a/composer.json b/composer.json
@@ -128,7 +128,19 @@
     },
     "scripts": {
         "translations:unused": "php bin/translations translations:unused",
-        "translations:update:translatable": "php bin/translations translations:update:translatable"
+        "translations:update:translatable": "php bin/translations translations:update:translatable",
+        "clear-symfony-cache": [
+            "php bin/console     cache:clear --no-warmup",
+            "php bin/console ssp-cache:clear --no-warmup"
+        ],
+        "post-update-cmd": [
+            "@clear-symfony-cache",
+            "echo 'Post-update tasks completed!'"
+        ],
+        "post-install-cmd": [
+            "@clear-symfony-cache",
+            "echo 'Post-install tasks completed!'"
+        ]
     },
     "version": "v2.4.0"
 }
diff --git a/config/config.php.dist b/config/config.php.dist
@@ -58,7 +58,7 @@ $config = [
     /*
      * The following settings are *filesystem paths* which define where
      * SimpleSAMLphp can find or write the following things:
-     * - 'cachedir': Where SimpleSAMLphp can write its cache. 
+     * - 'cachedir': Where SimpleSAMLphp can write its cache.
      * - 'loggingdir': Where to write logs. MUST be set to NULL when using a logging
      *                 handler other than `file`.
      * - 'datadir': Storage of general data.
@@ -564,7 +564,7 @@ $config = [
         'exampleauth' => false,
         'core' => true,
         'admin' => true,
-        'saml' => true
+        'saml' => true,
     ],
 
 
@@ -826,7 +826,7 @@ $config = [
     'language.available' => [
         'en', 'no', 'nn', 'se', 'da', 'de', 'sv', 'fi', 'es', 'ca', 'fr', 'it', 'nl', 'lb',
         'cs', 'sk', 'sl', 'lt', 'hr', 'hu', 'pl', 'pt', 'pt_BR', 'tr', 'ja', 'zh', 'zh_TW',
-        'ru', 'et', 'he', 'id', 'sr', 'lv', 'ro', 'eu', 'el', 'af', 'zu', 'xh', 'st'
+        'ru', 'et', 'he', 'id', 'sr', 'lv', 'ro', 'eu', 'el', 'af', 'zu', 'xh', 'st',
     ],
     'language.rtl' => ['ar', 'dv', 'fa', 'ur', 'he'],
     'language.default' => 'en',
diff --git a/docs/simplesamlphp-install-repo.md b/docs/simplesamlphp-install-repo.md
@@ -37,13 +37,28 @@ cp metadata/saml20-idp-remote.php.dist metadata/saml20-idp-remote.php
 cp metadata/saml20-sp-remote.php.dist metadata/saml20-sp-remote.php
 ```
 
-The default config.php has a setting `cachedir` which defaults to
-`/var/cache/simplesamlphp`. This directory should exist and be
-writable by the web server user. You may like to consider something
+SimpleSAMLphp uses Symfony to maintain a cache which is by default stored
+at `/var/cache/simplesamlphp`. You are encouraged to consider something
 like the ACL commands from the [Symfony
 website](https://symfony.com/doc/current/setup/file_permissions.html#1-using-acl-on-a-system-that-supports-setfacl-linux-bsd)
 to enable access to this cache directory.
 
+The cache directory is stored at the location indicated by the
+`cachedir` option in your config.php (defaulting to
+`/var/cache/simplesamlphp`). This directory should exist and be
+writable by the web server user and the user you use to run composer.
+
+Some commands which may be run from composer will want to clear this
+cache which leads to a situation that the cache directory will need
+permission to be updated by both the web server and also from your
+regular user account that you use to checkout the git repository and
+run composer.
+
+This is why it is recommended to use the solution provided on the
+[Symfony
+website](https://symfony.com/doc/current/setup/file_permissions.html#1-using-acl-on-a-system-that-supports-setfacl-linux-bsd)
+linked above to enable access to this cache directory.
+
 Install the external dependencies with Composer (you can refer to
 [getcomposer.org](https://getcomposer.org/) to get detailed
 instructions on how to install Composer itself):
diff --git a/phpcs.xml b/phpcs.xml
@@ -7,8 +7,6 @@
     </description>
 
     <file>bin</file>
-    <file>config</file>
-    <file>metadata</file>
     <file>modules</file>
     <file>public</file>
     <file>src</file>
diff --git a/routing/services/console.yml b/routing/services/console.yml
@@ -4,3 +4,9 @@ services:
   # default configuration for services in *this* file
   _defaults:
     public: false
+
+  SimpleSAML\Command\SspCacheClearCommand:
+    tags: ['console.command']
+    arguments:
+      $cacheClearer: '@cache_clearer'
+      $filesystem: '@filesystem'
diff --git a/src/SimpleSAML/Command/SspCacheClearCommand.php b/src/SimpleSAML/Command/SspCacheClearCommand.php
diff --git a/tests/src/SimpleSAML/ConfigurationTest.php b/tests/src/SimpleSAML/ConfigurationTest.php
