Merge pull request #154 from rtCamp/release/1-9-12

chandrapatel · web-flow · commit 9c44ef8da57f · 2018-09-24T14:51:48.000+05:30
Update readme files and minor fixes
diff --git a/README.md b/README.md
@@ -1,13 +1,13 @@
 # Nginx Helper #
 **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
 
-**Tags:** nginx, cache, purge, nginx map, nginx cache, maps, fastcgi, proxy, redis, redis-cache, rewrite, permalinks  
-**Requires at least:** 3.0  
-**Tested up to:** 4.9.5
-**Stable tag:** 1.9.11
-**License:** GPLv2 or later (of-course)  
-**License URI:** http://www.gnu.org/licenses/gpl-2.0.html  
-**Donate Link:** http://rtcamp.com/donate/  
+**Tags:** nginx, cache, purge, nginx map, nginx cache, maps, fastcgi, proxy, redis, redis-cache, rewrite, permalinks
+**Requires at least:** 3.0
+**Tested up to:** 4.9.8
+**Stable tag:** 1.9.12
+**License:** GPLv2 or later (of-course)
+**License URI:** http://www.gnu.org/licenses/gpl-2.0.html
+**Donate Link:** http://rtcamp.com/donate/
 
 Cleans nginx's fastcgi/proxy cache or redis-cache whenever a post is edited/published. Also does a few more things.
 
@@ -98,13 +98,15 @@ To purge a page immediately, follow these instructions:
 
 **Q. Can I override the redis hostname, port and prefix?**
 
-Yes, you can force override the redis hostname, port or prefix by using defines. For example:
+Yes, you can force override the redis hostname, port or prefix by defining constant in wp-config.php. For example:
 
-`define('RT_WP_NGINX_HELPER_REDIS_HOSTNAME', '10.0.0.1');`
+```
+define( 'RT_WP_NGINX_HELPER_REDIS_HOSTNAME', '10.0.0.1' );
 
-`define('RT_WP_NGINX_HELPER_REDIS_PORT', '6000');`
+define( 'RT_WP_NGINX_HELPER_REDIS_PORT', '6000' );
 
-`define('RT_WP_NGINX_HELPER_REDIS_PREFIX', 'page-cache:');`
+define( 'RT_WP_NGINX_HELPER_REDIS_PREFIX', 'page-cache:' );
+```
 
 
 ### FAQ - Nginx Map ###
@@ -132,6 +134,9 @@ Please post your problem in [our free support forum](http://community.rtcamp.com
 
 ## Changelog ##
 
+### 1.9.12 ###
+* Allow override Redis host/port/prefix by defining constant in wp-config.php [#152](https://github.com/rtCamp/nginx-helper/pull/152) - by [vincent-lu](https://github.com/vincent-lu)
+
 ### 1.9.11 ###
 * Fixed issue where permalinks without trailing slash does not purging [#124](https://github.com/rtCamp/nginx-helper/issues/124) - by Patrick
 * Check whether role exist or not before removing capability. [#134](https://github.com/rtCamp/nginx-helper/pull/134) - by [1gor](https://github.com/1gor)
@@ -362,6 +367,5 @@ Fix url escaping [#82](https://github.com/rtCamp/nginx-helper/pull/82) - by
 
 ## Upgrade Notice ##
 
-### 1.9.11 ###
-* Fixed issue where permalinks without trailing slash does not purging [#124](https://github.com/rtCamp/nginx-helper/issues/124) - by Patrick
-* Check whether role exist or not before removing capability. [#134](https://github.com/rtCamp/nginx-helper/pull/134) - by [1gor](https://github.com/1gor)
+### 1.9.12 ###
+* Allow override Redis host/port/prefix by defining constant in wp-config.php [#152](https://github.com/rtCamp/nginx-helper/pull/152) - by [vincent-lu](https://github.com/vincent-lu)
diff --git a/admin/lib/nginx-general.php b/admin/lib/nginx-general.php
@@ -52,8 +52,8 @@ function nginx_general_options_page()
 				$rt_wp_nginx_helper->options['purge_page_on_deleted_comment'] = ( isset( $_POST['purge_page_on_deleted_comment'] ) and ( $_POST['purge_page_on_deleted_comment'] == 1 ) ) ? 1 : 0;
 
 				$rt_wp_nginx_helper->options['purge_method'] = ( isset( $_POST['purge_method'] ) ) ? $_POST['purge_method'] : 'get_request';
-                
-                $rt_wp_nginx_helper->options['purge_url'] = ( isset( $_POST['purge_url'] ) && ! empty( $_POST['purge_url'] ) ) ? esc_textarea( $_POST['purge_url'] ) : '';
+
+				$rt_wp_nginx_helper->options['purge_url'] = ( isset( $_POST['purge_url'] ) && ! empty( $_POST['purge_url'] ) ) ? esc_textarea( $_POST['purge_url'] ) : '';
 			}
 			if ( isset( $_POST['cache_method'] ) && $_POST['cache_method'] = "enable_redis" ) {
 				$rt_wp_nginx_helper->options['redis_hostname'] = ( isset( $_POST['redis_hostname'] ) ) ? $_POST['redis_hostname'] : '127.0.0.1';
@@ -174,33 +174,33 @@ function nginx_general_options_page()
 								$redis_port = ( empty( $rt_wp_nginx_helper->options['redis_port'] ) ) ? '6379' : $rt_wp_nginx_helper->options['redis_port'];
 								$redis_prefix = ( empty( $rt_wp_nginx_helper->options['redis_prefix'] ) ) ? 'nginx-cache:' : $rt_wp_nginx_helper->options['redis_prefix'];
 
-                $redis_hostname = defined('RT_WP_NGINX_HELPER_REDIS_HOSTNAME') ? RT_WP_NGINX_HELPER_REDIS_HOSTNAME : $redis_hostname;
-                $redis_port = defined('RT_WP_NGINX_HELPER_REDIS_PORT') ? RT_WP_NGINX_HELPER_REDIS_PORT : $redis_port;
-                $redis_prefix = defined('RT_WP_NGINX_HELPER_REDIS_PREFIX') ? RT_WP_NGINX_HELPER_REDIS_PREFIX : $redis_prefix;
+								$redis_hostname = defined('RT_WP_NGINX_HELPER_REDIS_HOSTNAME') ? RT_WP_NGINX_HELPER_REDIS_HOSTNAME : $redis_hostname;
+								$redis_port = defined('RT_WP_NGINX_HELPER_REDIS_PORT') ? RT_WP_NGINX_HELPER_REDIS_PORT : $redis_port;
+								$redis_prefix = defined('RT_WP_NGINX_HELPER_REDIS_PREFIX') ? RT_WP_NGINX_HELPER_REDIS_PREFIX : $redis_prefix;
 
-                $redis_hostname_readonly = defined('RT_WP_NGINX_HELPER_REDIS_HOSTNAME') ? 'readonly="readonly"' : '';
-                $redis_port_readonly = defined('RT_WP_NGINX_HELPER_REDIS_PORT') ? 'readonly="readonly"' : '';
-                $redis_prefix_readonly = defined('RT_WP_NGINX_HELPER_REDIS_PREFIX') ? 'readonly="readonly"' : '';
+								$redis_hostname_readonly = defined('RT_WP_NGINX_HELPER_REDIS_HOSTNAME') ? 'readonly="readonly"' : '';
+								$redis_port_readonly = defined('RT_WP_NGINX_HELPER_REDIS_PORT') ? 'readonly="readonly"' : '';
+								$redis_prefix_readonly = defined('RT_WP_NGINX_HELPER_REDIS_PREFIX') ? 'readonly="readonly"' : '';
 								?>
 								<tr>
 									<th><label for="redis_hostname"><?php _e( 'Hostname', 'nginx-helper' ); ?></label></th>
 									<td>
 										<input id="redis_hostname" class="medium-text" type="text" name="redis_hostname" value="<?php echo $redis_hostname; ?>" <?php echo $redis_hostname_readonly; ?> />
-                    <?php if ($redis_hostname_readonly) echo '<p class="description">Overridden by global define</p>'; ?>
+										<?php if ($redis_hostname_readonly) echo '<p class="description">Overridden by global define</p>'; ?>
 									</td>
 								</tr>
 								<tr>
 									<th><label for="redis_port"><?php _e( 'Port', 'nginx-helper' ); ?></label></th>
 									<td>
 										<input id="redis_port" class="medium-text" type="text" name="redis_port" value="<?php echo $redis_port; ?>" <?php echo $redis_port_readonly; ?> />
-                    <?php if ($redis_port_readonly) echo '<p class="description">Overridden by global define</p>'; ?>
+										<?php if ($redis_port_readonly) echo '<p class="description">Overridden by global define</p>'; ?>
 									</td>
 								</tr>
 								<tr>
 									<th><label for="redis_prefix"><?php _e( 'Prefix', 'nginx-helper' ); ?></label></th>
 									<td>
 										<input id="redis_prefix" class="medium-text" type="text" name="redis_prefix" value="<?php echo $redis_prefix; ?>" <?php echo $redis_prefix_readonly; ?> />
-                    <?php if ($redis_prefix_readonly) echo '<p class="description">Overridden by global define</p>'; ?>
+										<?php if ($redis_prefix_readonly) echo '<p class="description">Overridden by global define</p>'; ?>
 									</td>
 								</tr>
 							</table>
@@ -416,7 +416,7 @@ function nginx_general_options_page()
 						$log = fopen( $path . 'nginx.log', 'w' );
 						fclose( $log );
 					}
-					
+
 					if ( !is_writable( $path . 'nginx.log' ) ) {
 						?>
 						<span class="error fade" style="display : block"><p><?php printf( __( 'Can\'t write on log file.<br /><br />Check you have write permission on <strong>%s</strong>', 'nginx-helper' ), $rt_wp_nginx_helper->functional_asset_path() . 'nginx.log' ); ?></p></span><?php }
diff --git a/includes/redis-delete.php b/includes/redis-delete.php
@@ -5,26 +5,27 @@
 
 global $myredis, $rt_wp_nginx_helper, $redis_api, $lua, $rt_wp_nginx_purger;
 
-$host = defined('RT_WP_NGINX_HELPER_REDIS_HOSTNAME') ? RT_WP_NGINX_HELPER_REDIS_HOSTNAME : $rt_wp_nginx_helper->options['redis_hostname'];
-$port = defined('RT_WP_NGINX_HELPER_REDIS_PORT') ? RT_WP_NGINX_HELPER_REDIS_PORT : $rt_wp_nginx_helper->options['redis_port'];
+$host = defined( 'RT_WP_NGINX_HELPER_REDIS_HOSTNAME' ) ? RT_WP_NGINX_HELPER_REDIS_HOSTNAME : $rt_wp_nginx_helper->options['redis_hostname'];
+$port = defined( 'RT_WP_NGINX_HELPER_REDIS_PORT' ) ? RT_WP_NGINX_HELPER_REDIS_PORT : $rt_wp_nginx_helper->options['redis_port'];
+
 $redis_api = '';
 
 if ( class_exists( 'Redis' ) ) { // Use PHP5-Redis if installed.
     try {
         $myredis = new Redis();
         $myredis->connect( $host, $port, 5 );
         $redis_api = 'php-redis';
-    } catch ( Exception $e ) { 
+    } catch ( Exception $e ) {
         if( isset($rt_wp_nginx_purger) && !empty($rt_wp_nginx_purger) ) {
-            $rt_wp_nginx_purger->log( $e->getMessage(), 'ERROR' ); 
+            $rt_wp_nginx_purger->log( $e->getMessage(), 'ERROR' );
         }
     }
 } else {
     if( ! class_exists( 'Predis\Autoloader' ) ) {
         require_once 'predis.php';
     }
     Predis\Autoloader::register();
-    
+
     //redis server parameter
     $myredis = new Predis\Client( [
         'host' => $host,
@@ -34,9 +35,9 @@
     try {
         $myredis->connect();
         $redis_api = 'predis';
-    } catch ( Exception $e ) { 
+    } catch ( Exception $e ) {
         if( isset($rt_wp_nginx_purger) && !empty($rt_wp_nginx_purger) ) {
-            $rt_wp_nginx_purger->log( $e->getMessage(), 'ERROR' ); 
+            $rt_wp_nginx_purger->log( $e->getMessage(), 'ERROR' );
         }
     }
 }
@@ -57,9 +58,9 @@
  */
 
 function delete_multi_keys( $key )
-{   
+{
     global $myredis, $redis_api, $rt_wp_nginx_purger;
-    
+
     try {
         if ( !empty( $myredis ) ) {
             $matching_keys = $myredis->keys( $key );
@@ -143,4 +144,4 @@ function delete_keys_by_wildcard( $pattern )
     } catch ( Exception $e ) { $rt_wp_nginx_purger->log( $e->getMessage(), 'ERROR' ); }
 }
 
-?>
+?>
diff --git a/nginx-helper.php b/nginx-helper.php
@@ -3,12 +3,12 @@
  * Plugin Name: Nginx Helper
  * Plugin URI: https://rtcamp.com/nginx-helper/
  * Description: Cleans nginx's fastcgi/proxy cache or redis-cache whenever a post is edited/published. Also does a few more things.
- * Version: 1.9.11
+ * Version: 1.9.12
  * Author: rtCamp
  * Author URI: https://rtcamp.com
  * Text Domain: nginx-helper
  * Requires at least: 3.0
- * Tested up to: 4.9.5
+ * Tested up to: 4.9.8
  *
  * @package nginx-helper
  */
@@ -414,12 +414,12 @@ function rt_nginx_get_news() {
 			return;
 		}
 
-		require_once( ABSPATH . WPINC . '/feed.php' );
+		require_once ABSPATH . WPINC . '/feed.php';
 
 		$maxitems = 0;
 
 		// Get a SimplePie feed object from the specified feed source.
-		$rss = fetch_feed( 'http://rtcamp.com/blog/feed/' );
+		$rss = fetch_feed( 'https://rtcamp.com/blog/feed/' );
 
 		// Checks that the object is created correctly.
 		if ( ! is_wp_error( $rss ) ) {
diff --git a/readme.txt b/readme.txt
@@ -5,8 +5,8 @@ Tags: nginx, cache, purge, nginx map, nginx cache, maps, fastcgi, proxy, redis,
 License: GPLv2 or later (of-course)
 License URI: http://www.gnu.org/licenses/gpl-2.0.html
 Requires at least: 3.0
-Tested up to: 4.9.5
-Stable tag: 1.9.11
+Tested up to: 4.9.8
+Stable tag: 1.9.12
 
 Cleans nginx's fastcgi/proxy cache or redis-cache whenever a post is edited/published. Also does a few more things.
 
@@ -92,6 +92,19 @@ 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'.
 
+= FAQ - Nginx Redis Cache =
+
+**Q. Can I override the redis hostname, port and prefix?**
+
+Yes, you can force override the redis hostname, port or prefix by defining constant in wp-config.php. For example:
+
+```
+define('RT_WP_NGINX_HELPER_REDIS_HOSTNAME', '10.0.0.1');
+
+define('RT_WP_NGINX_HELPER_REDIS_PORT', '6000');
+
+define('RT_WP_NGINX_HELPER_REDIS_PREFIX', 'page-cache:');
+```
 
 = FAQ - Nginx Map =
 
@@ -114,6 +127,9 @@ Please post your problem in [our free support forum](http://community.rtcamp.com
 
 == Changelog ==
 
+= 1.9.12 =
+* Allow override Redis host/port/prefix by defining constant in wp-config.php [#152](https://github.com/rtCamp/nginx-helper/pull/152) - by [vincent-lu](https://github.com/vincent-lu)
+
 = 1.9.11 =
 * Fixed issue where permalinks without trailing slash does not purging [#124](https://github.com/rtCamp/nginx-helper/issues/124) - by Patrick
 * Check whether role exist or not before removing capability. [#134](https://github.com/rtCamp/nginx-helper/pull/134) - by [1gor](https://github.com/1gor)
@@ -344,6 +360,5 @@ Fix url escaping [#82](https://github.com/rtCamp/nginx-helper/pull/82) - by
 
 == Upgrade Notice ==
 
-= 1.9.11 =
-* Fixed issue where permalinks without trailing slash does not purging [#124](https://github.com/rtCamp/nginx-helper/issues/124) - by Patrick
-* Check whether role exist or not before removing capability. [#134](https://github.com/rtCamp/nginx-helper/pull/134) - by [1gor](https://github.com/1gor)
+= 1.9.12 =
+* Allow override Redis host/port/prefix by defining constant in wp-config.php [#152](https://github.com/rtCamp/nginx-helper/pull/152) - by [vincent-lu](https://github.com/vincent-lu)
diff --git a/redis-purger.php b/redis-purger.php
@@ -118,9 +118,9 @@ function purgePost( $_ID )
 			} else {
 				$this->_purge_by_options( $_ID, $blog_id, $rt_wp_nginx_helper->options['purge_page_on_mod'], $rt_wp_nginx_helper->options['purge_archive_on_edit'], $rt_wp_nginx_helper->options['purge_archive_on_edit'] );
 			}
-            
+
             $this->purge_urls();
-            
+
 			$this->log( "Function purgePost END ^^^" );
 		}
 
@@ -220,9 +220,9 @@ function purgeUrl( $url, $feed = true ) {
 				$parse['path'] = '';
 			}
 
-            $host = defined('RT_WP_NGINX_HELPER_REDIS_HOSTNAME') ? RT_WP_NGINX_HELPER_REDIS_HOSTNAME : $rt_wp_nginx_helper->options['redis_hostname'];
+			$host = defined( 'RT_WP_NGINX_HELPER_REDIS_HOSTNAME' ) ? RT_WP_NGINX_HELPER_REDIS_HOSTNAME : $rt_wp_nginx_helper->options['redis_hostname'];
 
-            $prefix = defined('RT_WP_NGINX_HELPER_REDIS_PREFIX') ? RT_WP_NGINX_HELPER_REDIS_PREFIX : $rt_wp_nginx_helper->options['redis_prefix'];
+			$prefix = defined( 'RT_WP_NGINX_HELPER_REDIS_PREFIX' ) ? RT_WP_NGINX_HELPER_REDIS_PREFIX : $rt_wp_nginx_helper->options['redis_prefix'];
 
 			$_url_purge_base = $prefix . $parse['scheme'] . 'GET' . $parse['host'] . $parse['path'];
 
@@ -675,11 +675,12 @@ function purge_on_check_ajax_referer( $action, $result )
 		function true_purge_all()
 		{
 			global $rt_wp_nginx_helper;
-            $prefix = defined('RT_WP_NGINX_HELPER_REDIS_PREFIX') ? RT_WP_NGINX_HELPER_REDIS_PREFIX : $rt_wp_nginx_helper->options['redis_prefix'];
+
+			$prefix = defined( 'RT_WP_NGINX_HELPER_REDIS_PREFIX' ) ? RT_WP_NGINX_HELPER_REDIS_PREFIX : $rt_wp_nginx_helper->options['redis_prefix'];
 			$prefix = trim( $prefix );
-			
+
 			$this->log( '* * * * *' );
-			
+
 			// If Purge Cache link click from network admin then purge all
 			if( is_network_admin() ) {
 				delete_keys_by_wildcard( $prefix . '*' );
@@ -690,49 +691,51 @@ function true_purge_all()
 				delete_keys_by_wildcard( $prefix . $parse['scheme'] . 'GET' . $parse['host'] . $parse['path'] . '*' );
 				$this->log( '* ' . get_home_url() . ' Purged! * ' );
 			}
-			
+
 			$this->log( '* * * * *' );
 		}
-		
+
 		function purge_urls()
 		{
 			global $rt_wp_nginx_helper;
-			
+
 			$parse = parse_url( site_url() );
-            $host = defined('RT_WP_NGINX_HELPER_REDIS_HOSTNAME') ? RT_WP_NGINX_HELPER_REDIS_HOSTNAME : $rt_wp_nginx_helper->options['redis_hostname'];
-            $prefix = defined('RT_WP_NGINX_HELPER_REDIS_PREFIX') ? RT_WP_NGINX_HELPER_REDIS_PREFIX : $rt_wp_nginx_helper->options['redis_prefix'];
+
+			$host  = defined( 'RT_WP_NGINX_HELPER_REDIS_HOSTNAME' ) ? RT_WP_NGINX_HELPER_REDIS_HOSTNAME : $rt_wp_nginx_helper->options['redis_hostname'];
+			$prefix = defined( 'RT_WP_NGINX_HELPER_REDIS_PREFIX' ) ? RT_WP_NGINX_HELPER_REDIS_PREFIX : $rt_wp_nginx_helper->options['redis_prefix'];
+
 			$_url_purge_base = $prefix . $parse['scheme'] . 'GET' . $parse['host'];
-			
+
 			$purge_urls = isset( $rt_wp_nginx_helper->options['purge_url'] ) && ! empty( $rt_wp_nginx_helper->options['purge_url'] ) ?
 				explode( "\r\n", $rt_wp_nginx_helper->options['purge_url'] ) : array();
-			
-                        // Allow plugins/themes to modify/extend urls. Pass urls array in first parameter, second says if wildcards are allowed
-                        $purge_urls = apply_filters('rt_nginx_helper_purge_urls', $purge_urls, true);
-                        
-                        if( is_array( $purge_urls ) && ! empty( $purge_urls ) ) {
+
+			// Allow plugins/themes to modify/extend urls. Pass urls array in first parameter, second says if wildcards are allowed
+			$purge_urls = apply_filters('rt_nginx_helper_purge_urls', $purge_urls, true);
+
+			if( is_array( $purge_urls ) && ! empty( $purge_urls ) ) {
 				foreach ($purge_urls as $purge_url ) {
 					$purge_url = trim( $purge_url );
-					
+
 					if( strpos( $purge_url, '*' ) === false ) {
 						$purge_url = $_url_purge_base . $purge_url;
 						$status = delete_single_key( $purge_url );
 						if( $status ) {
-						    $this->log( "- Purge URL | " . $purge_url );
+							$this->log( "- Purge URL | " . $purge_url );
 						} else {
-						    $this->log( "- Not Found | " . $purge_url, 'ERROR' );
+							$this->log( "- Not Found | " . $purge_url, 'ERROR' );
 						}
 					} else {
 						$purge_url = $_url_purge_base . $purge_url;
 						$status = delete_keys_by_wildcard( $purge_url );
 						if( $status ) {
-						    $this->log( "- Purge Wild Card URL | " . $purge_url . " | ". $status . " url purged" );
+							$this->log( "- Purge Wild Card URL | " . $purge_url . " | ". $status . " url purged" );
 						} else {
-						    $this->log( "- Not Found | " . $purge_url, 'ERROR' );
+							$this->log( "- Not Found | " . $purge_url, 'ERROR' );
 						}
 					}
 				}
 			}
 		}
-		
+
 	}
 }
