feat(*): Move log and cache files and add auto_prepend_file mode sett…

…ing (#147) * feat(log and cache): Move log and cache files in uploads/crowdsec folder * docs(user guide): Update doc for new log and cache directory * feat(multisite): Handle common upload folder for multisite * feat(*): Update composer dependencies * style(constant): Remove obsolete constants and rename one * feat(auto_prepend): Add auto_prepend_file mode option and use it to create the static standalone settings file * feat(auto_prepend-file): Log error in case there is no standalone setting file
crowdsecurity · Mar 14, 2024 · 33ac5c4 · 33ac5c4
1 parent 7b252e4
commit 33ac5c4
Show file tree

Hide file tree

Showing 245 changed files with 2,382 additions and 1,568 deletions.
diff --git a/.cache/.gitignore b/.cache/.gitignore
diff --git a/.github/workflows/end-to-end-auto-prepend-test-suite.yml b/.github/workflows/end-to-end-auto-prepend-test-suite.yml
@@ -76,7 +76,13 @@ jobs:
           ddev get julienloizelet/ddev-crowdsec-php
 
       - name: Start DDEV
-        run: ddev start
+        uses: nick-fields/retry@v3
+        with:
+          timeout_minutes: 5
+          max_attempts: 3
+          shell: bash
+          command: |
+            ddev start
 
       - name: Download WordPress
         run: ddev wp core download --version=${{ matrix.wp-version }}
@@ -86,15 +92,15 @@ jobs:
           ddev wp core install --url='https://${{ env.WP_VERSION_CODE }}.ddev.site' --title='WordPress' --admin_user='admin' --admin_password='admin123' --admin_email='admin@admin.com'  
 
       - name: Clone ${{ env.EXTENSION_NAME }} files
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           path: ${{ env.EXTENSION_PATH }}
 
       - name: Prepare for playwright test
         run: |
           mkdir -p crowdsec/tls
           mkdir -p crowdsec/geolocation
-          cp .ddev/okaeli-add-on/wordpress/custom_files/crowdsec/php/cache-actions-from-plugin-folder.php cache-actions.php
+          cp .ddev/okaeli-add-on/wordpress/custom_files/crowdsec/php/cache-actions-with-wordpress-load.php cache-actions.php
           cp -r .ddev/okaeli-add-on/custom_files/crowdsec/cfssl/* crowdsec/tls
           ddev maxmind-download DEFAULT GeoLite2-City crowdsec/geolocation
           ddev maxmind-download DEFAULT GeoLite2-Country crowdsec/geolocation
@@ -142,6 +148,12 @@ jobs:
               exit 1
           fi
 
+      - name: Enable Plugin auto_prepend_file mode
+        uses: ./wp-content/plugins/crowdsec/.github/workflows/end-to-end/run-single-test
+        with:
+          test_path: ${{ github.workspace }}/${{ env.EXTENSION_PATH }}/tests/e2e-ddev
+          file_path: 10-enable-autoprependfile-mode.js
+
       - name: Run Live mode remediation tests
         uses: ./wp-content/plugins/crowdsec/.github/workflows/end-to-end/run-single-test
         with:

diff --git a/.github/workflows/end-to-end-multisite.yml b/.github/workflows/end-to-end-multisite.yml
@@ -78,7 +78,13 @@ jobs:
           ddev get julienloizelet/ddev-crowdsec-php
 
       - name: Start DDEV
-        run: ddev start
+        uses: nick-fields/retry@v3
+        with:
+          timeout_minutes: 5
+          max_attempts: 3
+          shell: bash
+          command: |
+            ddev start
 
       - name: Download WordPress
         run: ddev wp core download --version=${{ matrix.wp-version }}
@@ -96,15 +102,15 @@ jobs:
           ddev wp site create --slug="site2" --title="WordPress Site2"  
 
       - name: Clone ${{ env.EXTENSION_NAME }} files
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           path: ${{ env.EXTENSION_PATH }}
 
       - name: Prepare for playwright test
         run: |
           mkdir -p crowdsec/tls
           mkdir -p crowdsec/geolocation
-          cp .ddev/okaeli-add-on/wordpress/custom_files/crowdsec/php/cache-actions-from-plugin-folder.php cache-actions.php
+          cp .ddev/okaeli-add-on/wordpress/custom_files/crowdsec/php/cache-actions-with-wordpress-load.php cache-actions.php
           cp -r .ddev/okaeli-add-on/custom_files/crowdsec/cfssl/* crowdsec/tls
           ddev maxmind-download DEFAULT GeoLite2-City crowdsec/geolocation
           ddev maxmind-download DEFAULT GeoLite2-Country crowdsec/geolocation

diff --git a/.github/workflows/end-to-end-test-suite.yml b/.github/workflows/end-to-end-test-suite.yml
@@ -76,7 +76,13 @@ jobs:
           ddev get julienloizelet/ddev-crowdsec-php
 
       - name: Start DDEV
-        run: ddev start
+        uses: nick-fields/retry@v3
+        with:
+          timeout_minutes: 5
+          max_attempts: 3
+          shell: bash
+          command: |
+            ddev start
 
       - name: Download WordPress
         run: ddev wp core download --version=${{ matrix.wp-version }}
@@ -86,15 +92,15 @@ jobs:
           ddev wp core install --url='https://${{ env.WP_VERSION_CODE }}.ddev.site' --title='WordPress' --admin_user='admin' --admin_password='admin123' --admin_email='admin@admin.com'
 
       - name: Clone ${{ env.EXTENSION_NAME }} files
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           path: ${{ env.EXTENSION_PATH }}
 
       - name: Prepare for playwright test
         run: |
           mkdir -p crowdsec/tls
           mkdir -p crowdsec/geolocation
-          cp .ddev/okaeli-add-on/wordpress/custom_files/crowdsec/php/cache-actions-from-plugin-folder.php cache-actions.php
+          cp .ddev/okaeli-add-on/wordpress/custom_files/crowdsec/php/cache-actions-with-wordpress-load.php cache-actions.php
           cp -r .ddev/okaeli-add-on/custom_files/crowdsec/cfssl/* crowdsec/tls
           ddev maxmind-download DEFAULT GeoLite2-City crowdsec/geolocation
           ddev maxmind-download DEFAULT GeoLite2-Country crowdsec/geolocation

diff --git a/.github/workflows/markdown.yml b/.github/workflows/markdown.yml
@@ -13,7 +13,7 @@ jobs:
     steps:
 
       - name: Clone sources
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           path: extension
 

diff --git a/.github/workflows/release-test.yml b/.github/workflows/release-test.yml
@@ -81,7 +81,13 @@ jobs:
           ddev get julienloizelet/ddev-crowdsec-php
 
       - name: Start DDEV
-        run: ddev start
+        uses: nick-fields/retry@v3
+        with:
+          timeout_minutes: 5
+          max_attempts: 3
+          shell: bash
+          command: |
+            ddev start
 
       - name: Download WordPress
         run: ddev wp core download --version=${{ matrix.wp-version }}
@@ -96,15 +102,15 @@ jobs:
 
       - name: Clone files from last release
         if: github.event.inputs.check_head_zip != 'true'
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           path: raw_sources
           ref: "v${{ env.LAST_TAG }}"
           repository: "${{ env.GITHUB_ORIGIN }}"
 
       - name: Clone files from HEAD
         if: github.event.inputs.check_head_zip == 'true'
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           path: raw_sources
 
@@ -131,7 +137,7 @@ jobs:
         run: |
           mkdir -p crowdsec/tls
           mkdir -p crowdsec/geolocation
-          cp .ddev/okaeli-add-on/wordpress/custom_files/crowdsec/php/cache-actions-from-plugin-folder.php cache-actions.php
+          cp .ddev/okaeli-add-on/wordpress/custom_files/crowdsec/php/cache-actions-with-wordpress-load.php cache-actions.php
           cp -r .ddev/okaeli-add-on/custom_files/crowdsec/cfssl/* crowdsec/tls
           ddev maxmind-download DEFAULT GeoLite2-City crowdsec/geolocation
           ddev maxmind-download DEFAULT GeoLite2-Country crowdsec/geolocation

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -41,7 +41,21 @@ jobs:
                     echo "VERSION_NUMBER=$(echo ${{ github.event.inputs.tag_name }} | sed 's/v//g' )" >> $GITHUB_ENV
 
             -   name: Clone sources
-                uses: actions/checkout@v3
+                uses: actions/checkout@v4
+
+            -   name: Check standalone-settings exists and is empty
+                run: |
+                    if [ ! -f inc/standalone-settings.php ]
+                    then
+                      echo "inc/standalone-settings.php does not exist"
+                      exit 1
+                    elif [ -s inc/standalone-settings.php ]
+                    then
+                      echo "inc/standalone-settings.php is not empty"
+                      exit 1
+                    else
+                      echo "inc/standalone-settings.php exists and is empty"
+                    fi
 
             -   name: Check version ${{ env.VERSION_NUMBER }} consistency in files
                 # Check crowdsec.php (2), readme.txt (1), inc/Constants.php (1) and CHANGELOG.md (3)
@@ -111,7 +125,7 @@ jobs:
                     fi
 
             -   name: Create Tag ${{ github.event.inputs.tag_name }}
-                uses: actions/github-script@v6
+                uses: actions/github-script@v7
                 with:
                     github-token: ${{ github.token }}
                     script: |
@@ -222,7 +236,13 @@ jobs:
                   ddev get julienloizelet/ddev-crowdsec-php
 
             - name: Start DDEV
-              run: ddev start
+              uses: nick-fields/retry@v3
+              with:
+                  timeout_minutes: 5
+                  max_attempts: 3
+                  shell: bash
+                  command: |
+                      ddev start
 
             - name: Download WordPress
               run: ddev wp core download --version=${{ matrix.wp-version }}
@@ -236,7 +256,7 @@ jobs:
                   echo "LAST_TAG=$(curl -Ls -o /dev/null -w %{url_effective} https://github.com/${{ env.GITHUB_ORIGIN }}/releases/latest | grep -oP "\/tag\/v\K(.*)$")" >> $GITHUB_ENV
 
             - name: Clone files from last release
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
               with:
                   path: raw_sources
                   ref: "v${{ env.LAST_TAG }}"
@@ -256,7 +276,7 @@ jobs:
               run: |
                   mkdir -p crowdsec/tls
                   mkdir -p crowdsec/geolocation
-                  cp .ddev/okaeli-add-on/wordpress/custom_files/crowdsec/php/cache-actions-from-plugin-folder.php cache-actions.php
+                  cp .ddev/okaeli-add-on/wordpress/custom_files/crowdsec/php/cache-actions-with-wordpress-load.php cache-actions.php
                   cp -r .ddev/okaeli-add-on/custom_files/crowdsec/cfssl/* crowdsec/tls
                   ddev maxmind-download DEFAULT GeoLite2-City crowdsec/geolocation
                   ddev maxmind-download DEFAULT GeoLite2-Country crowdsec/geolocation

diff --git a/.gitignore b/.gitignore
@@ -10,4 +10,6 @@ node_modules/
 
 # App
 *.log
+
+# auto_prepend_file mode settings
 inc/standalone-settings.php
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,21 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [2.6.0](https://github.com/crowdsecurity/cs-wordpress-bouncer/releases/tag/v2.6.0) - 2024-03-14
+[_Compare with previous release_](https://github.com/crowdsecurity/cs-wordpress-bouncer/compare/v2.5.2...v2.6.0)
+
+### Changed
+
+- Move logs and cache folders to `wp-content/uploads/crowdsec` to avoid deletion on plugin update and pass checksum validation
+- Write `standalone-settings.php` file only if the new setting `Enable auto_prepend_file mode` is on.
+
+### Added
+
+- Add a `Enable auto_prepend_file mode` setting.
+
+
+---
+
 
 ## [2.5.2](https://github.com/crowdsecurity/cs-wordpress-bouncer/releases/tag/v2.5.2) - 2023-11-23
 [_Compare with previous release_](https://github.com/crowdsecurity/cs-wordpress-bouncer/compare/v2.5.1...v2.5.2)