merge: fix conflicts

Author: Vedant-Gandhi

.github/ci/main.sh

@@ -26,7 +26,7 @@ function start_services() {
 # Create, setup and populate learn.rtcamp.com base site with data
 function create_and_configure_site () {
 
- ee site create $SITE_NAME --wp --php74 
+ ee site create $SITE_NAME --wp --php74
  cd $SITE_ROOT/wp-content/plugins/
  rm -rf nginx-helper
  ls
@@ -36,7 +36,6 @@ function create_and_configure_site () {
  ls
  wp plugin activate nginx-helper --allow-root
  wp user create automation automation@example.com --role=administrator --user_pass=automation --allow-root
- wp theme activate twentytwentyone --allow-root
 }
 
 
@@ -55,7 +54,7 @@ function build_package(){
 }
 
 function install_playwright(){
-  cd $GITHUB_WORKSPACE/tests/e2e-playwright
+ cd $GITHUB_WORKSPACE/tests/e2e-playwright
  npx playwright install
 }
 
@@ -96,4 +95,4 @@ function main() {
  run_playwright_tests
 }
 
-main
+main

.github/workflows/create.yml

@@ -15,5 +15,5 @@ jobs:
  EXCLUDE_LIST: .gitattributes .gitignore .travis.yml README.md deploy.sh readme.sh
  tests map.conf nginx.log wercker.yml vendor
  SLUG: nginx-helper
- WORDPRESS_PASSWORD: ${{ secrets.WORDPRESS_PASSWORD }}
- WORDPRESS_USERNAME: ${{ secrets.WORDPRESS_USERNAME }}
+ WORDPRESS_PASSWORD: ${{ secrets.SVN_PASSWORD }}
+ WORDPRESS_USERNAME: ${{ secrets.SVN_USERNAME }}

.github/workflows/e2e-test.yml

@@ -5,15 +5,15 @@ name: End-to-End Tests
 # Controls when the workflow will run
 on:
  # Triggers the workflow on push or pull request events but only for the main branch
- push:
- branches: 
- - develop
- - master
- 
- pull_request:
- branches: 
- - develop
- - master
+#  push:
+#  branches:
+#  - develop
+#  - master
+
+#  pull_request:
+#  branches:
+#  - develop
+#  - master
 
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:
@@ -23,14 +23,14 @@ jobs:
  # The type of runner that the job will run on
  name: Playwright Tests
  runs-on: ubuntu-latest
- env: 
+ env:
  TESRESULT_TOKEN: ${{ secrets.TESRESULT_TOKEN }}
  TOKEN: ${{ secrets.GITHUB_TOKEN }}
  SHA: ${{ github.event.pull_request.head.sha }}
  COMMIT_SHA: ${{ github.sha }}
  PR_NUMBER: ${{ github.event.pull_request.number }}
  working-directory: ./tests/e2e-playwright
- 
+
  # Steps represent a sequence of tasks that will be executed as part of the job
  steps:
  # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
@@ -52,7 +52,7 @@ jobs:
 
  - name: Archive HTML Report on failure
  if: failure()
- uses: actions/upload-artifact@v1
+ uses: actions/upload-artifact@v4
  with:
  name: report
  path: ./tests/e2e-playwright/config

Development.md

@@ -0,0 +1,52 @@
+# Development
+[ For internal contributors only ]
+
+## Getting Started
+
+To set up the repo locally, choose one of the following methods:
+
+### Method 1 (For FastCGI or Srcache)
+
+1. Create a WordPress website.
+2. Clone the [nginx](https://github.com/nginx/nginx) source code in a separate directory.
+3. Set up nginx using either FastCGI cache or Srcache module.
+4. Manually compile the binary for Nginx.
+5. Add a configuration block to redirect incoming requests to the WordPress website.
+6. Clone this repository inside the `wp-content/plugins` directory.
+
+### Method 2 (For Redis Cache)
+
+1. Install EasyEngine by following the [instructions](https://easyengine.io/cli/handbook/install/).
+2. Create a site with caching enabled using the command: `ee site create <site_name> --cache`
+
+3. Clone this repository inside the `wp-content/plugins` directory of the newly created site.
+
+## Testing
+
+To verify if a page is cached:
+
+1. Enable the timestamp option in Nginx Helper from the WordPress Admin Page:
+- This adds a comment with cache time and query count.
+- Cached pages should show only 1 query.
+
+2. Manually check the Redis database:
+- Search for keys beginning with the prefix specified in your Redis config, followed by a URL.
+
+## Contributing
+
+### Raising a Pull Request (PR)
+
+1. Create a new branch from `master` for your changes.
+2. Make your changes and commit them to your branch.
+3. Raise a PR targeting the `develop` branch.
+4. Assign the PR to a reviewer.
+5. Address any feedback and make necessary changes.
+6. Once approved, merge the PR into the `develop` branch.
+
+### Merging to Master
+
+1. After thorough testing on the `develop` branch, create a new PR.
+2. Set the source branch as the original feature branch that was merged into `develop`.
+3. Set the target branch as `master`.
+4. Assign reviewers and await final approval.
+5. Once approved, merge the PR into the `master` branch.

README.md

@@ -1,15 +1,15 @@
 # Nginx Helper #
 [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 
-**Contributors:** rtcamp, rahul286, saurabhshukla, manishsongirkar36, faishal, desaiuditd, darren-slatten, jk3us, daankortenbach, telofy, pjv, llonchj, jinnko, weskoop, bcole808, gungeekatx, rohanveer, chandrapatel, gagan0123, ravanh, michaelbeil, samedwards, niwreg, entr, nuvoPoint, iam404, rittesh.patel, vishalkakadiya, BhargavBhandari90, vincent-lu, murrayjbrown, bryant1410, 1gor, matt-h, pySilver, johan-chassaing, dotsam, sanketio, petenelson, nathanielks, rigagoogoo, dslatten, jinschoi, kelin1003, vaishuagola27, rahulsprajapati, Joel-James, utkarshpatel, gsayed786, shashwatmittal, sudhiryadav, thrijith, stayallive, jaredwsmith, abhijitrakas, umeshnevase, sid177, souptik, arafatkn, subscriptiongroup
+**Contributors:** rtcamp, rahul286, saurabhshukla, manishsongirkar36, faishal, desaiuditd, darren-slatten, jk3us, daankortenbach, telofy, pjv, llonchj, jinnko, weskoop, bcole808, gungeekatx, rohanveer, chandrapatel, gagan0123, ravanh, michaelbeil, samedwards, niwreg, entr, nuvoPoint, iam404, rittesh.patel, vishalkakadiya, BhargavBhandari90, bryant1410, 1gor, matt-h, dotsam, nathanielks, rigagoogoo, dslatten, jinschoi, kelin1003, vaishuagola27, rahulsprajapati, utkarshpatel, gsayed786, shashwatmittal, sudhiryadav, thrijith, stayallive, jaredwsmith, abhijitrakas, umeshnevase, sid177, souptik, arafatkn, subscriptiongroup, akrocks, vedantgandhi28, GridPane, stefanfisk, SGr33n, agvs, diepbui4157, pratiklondhe, webdados, ghost, ravanh, tjalexander70, mrrobot47, alexliii, joelmcdwebworks, bozzmedia, millionleave, kubajosef, alexsina, tomeryatir, minzak, peterdowney01, rayeason, gnif
 
-**Tags:** nginx, cache, purge, nginx map, nginx cache, maps, fastcgi, proxy, redis, redis-cache, rewrite, permalinks
+**Tags:** nginx, cache-purge, fastcgi, permalinks, redis-cache
 
 **Requires at least:** 3.0
 
-**Tested up to:** 6.1
+**Tested up to:** 6.8
 
-**Stable tag:** 2.2.3
+**Stable tag:** 2.3.5
 
 **License:** GPLv2 or later (of-course)
 
@@ -76,6 +76,16 @@ Replace the path with your own.
 
 Yes. It handles all post-types the same way.
 
+**Q. How can I purge cache automatically after WordPress/plugin/theme updates?**
+
+By default, Nginx Helper does **not** purge cache on WordPress core, plugin, or theme updates. 
+If you want this behavior, you can enable it using a filter:
+
+`add_filter( 'rt_wp_nginx_helper_enable_auto_purge_on_any_update', '__return_true' );`
+
+Once enabled, cache will be purged automatically whenever WordPress core, plugins, or themes are updated. 
+If left disabled (default), Nginx Helper will instead show an admin notice after updates, reminding you to purge cache manually.
+
 **Q. How do I know my Nginx config is correct for fastcgi purging?**
 
 Manually purging any page from the cache, by following instructions in the previous answer.
@@ -99,6 +109,24 @@ To purge a page immediately, follow these instructions:
 * Just open this in a browser and the page will be purged instantly.
 * Needless to say, this won't work, if you have a page or taxonomy called 'purge'.
 
+**Q. Does it need any kind of URL structure?**
+
+Yes. When setting the URL structure in Nginx configuration file a trailing slash should always be added.
+
+**Q. How can I automatically purge cache when WooCommerce product stock reduces after purchase?**
+
+Nginx Helper now includes optional WooCommerce integration.
+If enabled, cache for purchased products or products updated via REST API will be purged automatically.
+
+To use it:
+
+1. Go to Nginx Helper → Settings → WooCommerce Options.
+2. Tick “Purge product cache on updates”.
+
+This ensures customers always see up-to-date stock status and product information without stale cache.
+
+Note: This option will only be visible if WooCommerce is active.
+
 ### FAQ - Nginx Redis Cache ###
 
 **Q. Can I override the redis hostname, port and prefix?**
@@ -113,6 +141,18 @@ define( 'RT_WP_NGINX_HELPER_REDIS_PORT', '6000' );
 define( 'RT_WP_NGINX_HELPER_REDIS_PREFIX', 'page-cache:' );
 ```
 
+**Q. Can I override the redis socket path, username, password?**
+
+Yes, you can force override the redis socket path, username, password by defining constant in wp-config.php. For example:
+
+```php
+define( 'RT_WP_NGINX_HELPER_REDIS_UNIX_SOCKET', '/var/run/redis/redis.sock' );
+
+define( 'RT_WP_NGINX_HELPER_REDIS_USERNAME', 'admin' );
+
+define( 'RT_WP_NGINX_HELPER_REDIS_PASSWORD', 'admin' );
+```
+
 ### FAQ - Nginx Map ###
 
 **Q. My multisite already uses `WPMU_ACCEL_REDIRECT`. Do I still need Nginx Map?**
@@ -123,6 +163,16 @@ Definitely. `WPMU_ACCEL_REDIRECT` reduces the load on PHP, but it still ask Word
 
 Most likely yes. A wordpress plugin, if not using explicitly any Apache-only mod, should work on Nginx. Some plugin may need some extra work.
 
+
+### FAQ - WP-CLI ###
+
+**Q. How can I update the options using WP-CLI?**
+
+```shell
+wp option patch update rt_wp_nginx_helper_options <option_name> <option_value>
+```
+
+
 ### Still need help! ###
 
 Please post your problem in [our free support forum](https://github.com/rtCamp/nginx-helper/issues).
@@ -139,6 +189,52 @@ Please post your problem in [our free support forum](https://github.com/rtCamp/n
 
 ## Changelog ##
 
+### 2.3.5 ###
+
+* Purge not working. [#Issue](https://wordpress.org/support/topic/purge-not-working-7/) - by [tjalexander70](https://profiles.wordpress.org/tjalexander70/), [mrrobot47](https://github.com/mrrobot47)
+
+### 2.3.4 ###
+
+* Cannot uncheck Purge Homephae options. [#Issue](https://wordpress.org/support/topic/cannot-uncheck-purge-homephae-options/) - by [diepbui4157](https://profiles.wordpress.org/diepbui4157/)
+* fastcgi cache purge fails if not using trailing slashes in URI structure. [#Issue](https://wordpress.org/support/topic/fastcgi-cache-purge-fails-if-not-using-trailing-slashes-in-uri-structure/) - by [agvs](https://profiles.wordpress.org/agvs/), [Vedant-Gandhi](https://github.com/Vedant-Gandhi)
+* What's _purge_personal_urls() for?. [#Issue](https://wordpress.org/support/topic/whats-_purge_personal_urls-for/) - by [Rolf Allard van Hagen](https://profiles.wordpress.org/ravanh/), [pratik-londhe4](https://github.com/pratik-londhe4)
+* Broken link in the useful links section. [#358](https://github.com/rtCamp/nginx-helper/issues/358) - by [diepbui4157](https://profiles.wordpress.org/diepbui4157/), [pratik-londhe4](https://github.com/pratik-londhe4)
+* Small issues with translatable strings. [#348](https://github.com/rtCamp/nginx-helper/issues/348) - by [webdados](https://github.com/webdados)
+* New filter for RT_WP_NGINX_HELPER_CACHE_PATH default constant value. [#298](https://github.com/rtCamp/nginx-helper/issues/298) - by [SGr33n](https://github.com/SGr33n) [Vedant-Gandhi](https://github.com/Vedant-Gandhi)
+* PURGUE FOR EDITOR. [#243](https://github.com/rtCamp/nginx-helper/issues/243) - by [ghost](https://github.com/ghost), [pratik-londhe4](https://github.com/pratik-londhe4)
+
+
+### 2.3.3 ###
+
+* Fix AMP Purge for method unlink. [#396](https://github.com/rtCamp/nginx-helper/issues/343) - by [Stefan Fisk](https://github.com/stefanfisk)
+
+### 2.3.2 ###
+
+* Update the contributors list for the plugin. [#343](https://github.com/rtCamp/nginx-helper/issues/343) - by [Vedant Gandhi](https://github.com/Vedant-Gandhi)
+
+### 2.3.1 ###
+
+* Update the contributors list and tags for the plugin. [#378](https://github.com/rtCamp/nginx-helper/issues/378) - by [Vedant Gandhi](https://github.com/Vedant-Gandhi)
+
+### 2.3.0 ###
+
+* Disable the purge functionality when importing data. [#52](https://github.com/rtCamp/nginx-helper/pull/52) - by [Vedant Gandhi](https://github.com/Vedant-Gandhi)
+* Added option to preload cache for all Post and Pages. [#47](https://github.com/rtCamp/nginx-helper/pull/47) - by [Vedant Gandhi](https://github.com/Vedant-Gandhi)
+* Added the capability to purge Amp URL's. [#135](https://github.com/rtCamp/nginx-helper/pull/135) - by [Vedant Gandhi](https://github.com/Vedant-Gandhi)
+* Add support for adding Username, Password support for Redis. It also includes the support for Unix Socket Path for Redis along with Database selection. [#343](https://github.com/rtCamp/nginx-helper/pull/343),[#350](https://github.com/rtCamp/nginx-helper/pull/350) - by [Vedant Gandhi](https://github.com/Vedant-Gandhi)
+* Add capability to allow modifying options using WP-CLI. [#307](https://github.com/rtCamp/nginx-helper/pull/307) - by [Vedant Gandhi](https://github.com/Vedant-Gandhi)
+* Fix the plugin crash issue due to internationalization after upgrading to WordPress Version 6.7. [#364](https://github.com/rtCamp/nginx-helper/pull/364) - by [Vedant Gandhi](https://github.com/Vedant-Gandhi)
+
+### 2.2.5 ###
+
+* Add the capability to enable/disable purging of feeds. [#281](https://github.com/rtCamp/nginx-helper/issues/281) - by [Amaan Khan](https://github.com/pathan-amaankhan)
+* Fix undefined port error when Redis port is set to empty string. [#333](https://github.com/rtCamp/nginx-helper/issues/333) - by [Amaan Khan](https://github.com/pathan-amaankhan)
+
+### 2.2.4 ###
+
+* Introduces the capability to specify the `NGINX_HELPER_LOG` constant, allowing users to activate the logging feature. [#318](https://github.com/rtCamp/nginx-helper/pull/318) - by [Vishal Kakadiya](https://github.com/vishalkakadiya)
+* Existing users employing the nginx-helper plugin with logging enabled will experience no disruptions. However, if logging is disabled, users must define the `NGINX_HELPER_LOG` constant to re-enable the logging feature.
+
 ### 2.2.3 ###
 
 * Add the URL being purged as parameter in `rt_nginx_helper_purge_cached_file` hook. [#271](https://github.com/rtCamp/nginx-helper/pull/271) - by [Arafat Islam](https://github.com/arafatkn)

admin/class-fastcgi-purger.php

@@ -57,7 +57,7 @@ public function purge_url( $url, $feed = true ) {
 
 $this->delete_cache_file_for( $_url_purge );
 
-if ( $feed ) {
+if ( $feed && ! empty( $nginx_helper_admin->options['purge_feeds'] ) ) {
 
 $feed_url = rtrim( $_url_purge_base, '/' ) . '/feed/';
 $this->delete_cache_file_for( $feed_url );
@@ -83,7 +83,7 @@ public function purge_url( $url, $feed = true ) {
 
 $this->do_remote_get( $_url_purge );
 
-if ( $feed ) {
+if ( $feed && ! empty( $nginx_helper_admin->options['purge_feeds'] ) ) {
 
 $feed_url = rtrim( $_url_purge_base, '/' ) . '/feed/';
 $this->do_remote_get( $feed_url );
@@ -94,7 +94,30 @@ public function purge_url( $url, $feed = true ) {
 break;
 
 }
+
+if( ( is_page() || is_single() ) && $nginx_helper_admin->options['purge_amp_urls'] ) {
+$this->purge_amp_version( $url );
+}
+
+}
+
+/**
+ * Purge AMP version of a URL.
+ *
+ * @param string $url_base The base URL to purge.
+ */
+private function purge_amp_version( $url_base ) {
+global $nginx_helper_admin;
 
+$amp_url = sprintf( '%s/amp/', rtrim( $url_base, '/' ) );
+
+$this->log( '- Purging AMP URL | ' . $amp_url );
+
+if ( 'unlink_files' === $nginx_helper_admin->options['purge_method'] ) {
+$this->delete_cache_file_for( $amp_url );
+} else {
+$this->do_remote_get( $amp_url );
+}
 }
 
 /**