Merge in changes from master branch of upstream php-memcached (3.0.3 release)

Author: malyeyev-AMZN

ChangeLog

@@ -1,7 +1,20 @@
 memcached extension changelog
 
+Version 3.0.3 (2017-02-19)
+--------------------------
+
+	* Fix crash when checking session data with older versions of libmemcached (#328)
+	* Fix crash due to zend_mm_corrupted when fetching session data (#327)
+
+Version 3.0.2 (2017-02-12)
+--------------------------
+
+	* Update warning for touch command in binary protocol mode with libmemcached < 1.0.18 (#322)
+	* Add tests for 64-bit increment/decrement/incrementByKey/decrementByKey (#321)
+	* Fix tests for 32-bit increment/decrement/incrementByKey/decrementByKey (#319)
+
 Version 3.0.1 (2017-02-07)
--------------
+--------------------------
 
 	* Add API entries for flushBuffers() and getAllKeys() (#316)
 	* Ignore specific errors from memcached_dump for getAllKeys() with newer memcached servers (#315)

README.markdown

@@ -99,7 +99,7 @@ php-memcached 2.x:
 * Optionally supports igbinary 1.0 or higher.
 * Optionally supports msgpack 0.5 or higher.
 
-[libmemcached](http://libmemcached.org/libMemcached.html) version 1.0.16 or
+[libmemcached](http://libmemcached.org/libMemcached.html) version 1.0.18 or
 higher is recommended for best performance and compatibility with memcached
 servers.
 

package.xml

@@ -21,9 +21,15 @@ http://pear.php.net/dtd/package-2.0.xsd">
   <email>[email protected]</email>
   <active>yes</active>
  </lead>
- <date>2017-02-07</date>
+ <lead>
+  <name>Aaron Stone</name>
+  <user>sodabrew</user>
+  <email>[email protected]</email>
+  <active>yes</active>
+ </lead>
+ <date>2017-02-19</date>
  <version>
-  <release>3.0.1</release>
+  <release>3.0.3</release>
   <api>3.0.0</api>
  </version>
  <stability>
@@ -37,11 +43,8 @@ and the oldest actively tested version is 1.0.2. It is highly recommended to use
 libmemcached.
 
 Fixes
- * Add API entries for flushBuffers() and getAllKeys() (#316)
- * Ignore specific errors from memcached_dump for getAllKeys() with newer memcached servers (#315)
- * Fix compiling with memcached binary protocol enabled (#312)
- * Restore php_libmemcached_compat with workaround for missing memcached_exists (#314)
- * Travis CI purge old versions of memcached and libmemcached (#309)
+ * Fix crash when checking session data with older versions of libmemcached (#328)
+ * Fix crash due to zend_mm_corrupted when fetching session data (#327)
  </notes>
  <contents>
   <dir name="/">
@@ -68,6 +71,7 @@ Fixes
    <file role='src' name='fastlz/fastlz.c'/>
    <file role='src' name='fastlz/fastlz.h'/>
    <dir name="tests">
+    <file role='test' name='skipif.inc'/>
     <file role='test' name='001.phpt'/>
     <file role='test' name='version.phpt'/>
     <file role='test' name='bug_16084.phpt'/>
@@ -112,6 +116,7 @@ Fixes
     <file role='test' name='session_basic.phpt'/>
     <file role='test' name='session_basic2.phpt'/>
     <file role='test' name='session_basic3.phpt'/>
+    <file role='test' name='session_persistent.phpt'/>
     <file role='test' name='set_large.phpt'/>
     <file role='test' name='setoptions.phpt'/>
     <file role='test' name='touch_binary.phpt'/>
@@ -137,6 +142,7 @@ Fixes
     <file role='test' name='setmulti.phpt'/>
     <file role='test' name='cachecallback.phpt'/>
     <file role='test' name='incrdecr.phpt'/>
+    <file role='test' name='incrdecr_64.phpt'/>
     <file role='test' name='incrdecr_initial.phpt'/>
     <file role='test' name='incrdecr_invalid_key.phpt'/>
     <file role='test' name='incrdecr_bykey.phpt'/>
@@ -149,6 +155,7 @@ Fixes
     <file role='test' name='gh_155.phpt'/>
     <file role='test' name='get_flags.phpt'/>
     <file role='test' name='session_lock.phpt'/>
+    <file role='test' name='session_lazy_warning.phpt'/>
     <file role='test' name='session_regenerate.phpt'/>
     <file role='test' name='stats.phpt'/>
     <file role='test' name='default_behavior.phpt'/>
@@ -182,6 +189,50 @@ Fixes
   <configureoption name="with-libmemcached-dir" default="no" prompt="libmemcached directory"/>
  </extsrcrelease>
  <changelog>
+    <release>
+      <stability>
+        <release>stable</release>
+        <api>stable</api>
+      </stability>
+      <version>
+        <release>3.0.2</release>
+        <api>3.0.0</api>
+      </version>
+      <date>2016-02-12</date>
+      <notes>
+PHP7 release of memcached extension. Note that support for libmemcached 0.x series has been discontinued
+and the oldest actively tested version is 1.0.2. It is highly recommended to use version 1.0.18 of
+libmemcached.
+
+Fixes
+ * Update warning for touch command in binary protocol mode with libmemcached below 1.0.18 (#322)
+ * Add tests for 64-bit increment/decrement/incrementByKey/decrementByKey (#321)
+ * Fix tests for 32-bit increment/decrement/incrementByKey/decrementByKey (#319)
+      </notes>
+    </release>
+    <release>
+      <stability>
+        <release>stable</release>
+        <api>stable</api>
+      </stability>
+      <version>
+        <release>3.0.1</release>
+        <api>3.0.0</api>
+      </version>
+      <date>2016-02-07</date>
+      <notes>
+PHP7 release of memcached extension. Note that support for libmemcached 0.x series has been discontinued
+and the oldest actively tested version is 1.0.2. It is highly recommended to use version 1.0.18 of
+libmemcached.
+
+Fixes
+ * Add API entries for flushBuffers() and getAllKeys() (#316)
+ * Ignore specific errors from memcached_dump for getAllKeys() with newer memcached servers (#315)
+ * Fix compiling with memcached binary protocol enabled (#312)
+ * Restore php_libmemcached_compat with workaround for missing memcached_exists (#314)
+ * Travis CI purge old versions of memcached and libmemcached (#309)
+      </notes>
+    </release>
     <release>
       <stability>
         <release>stable</release>

php_libmemcached_compat.c

@@ -18,20 +18,42 @@
 #include "php_memcached_private.h"
 #include "php_libmemcached_compat.h"
 
-memcached_return php_memcached_exist (memcached_st *memc, zend_string *key)
+memcached_return php_memcached_exist(memcached_st *memc, zend_string *key)
 {
 #ifdef HAVE_MEMCACHED_EXIST
-	return memcached_exist (memc, key->val, key->len);
+	return memcached_exist(memc, key->val, key->len);
 #else
 	memcached_return rc = MEMCACHED_SUCCESS;
 	uint32_t flags = 0;
 	size_t value_length = 0;
 	char *value = NULL;
 
-	value = memcached_get (memc, key->val, key->len, &value_length, &flags, &rc);
+	value = memcached_get(memc, key->val, key->len, &value_length, &flags, &rc);
 	if (value) {
-		free (value);
+		zend_bool *is_persistent = memcached_get_user_data(memc);
+		pefree(value, *is_persistent);
 	}
 	return rc;
 #endif
 }
+
+memcached_return php_memcached_touch(memcached_st *memc, const char *key, size_t key_len, time_t expiration)
+{
+#if defined(LIBMEMCACHED_VERSION_HEX) && LIBMEMCACHED_VERSION_HEX < 0x01000018
+	if (memcached_behavior_get(memc, MEMCACHED_BEHAVIOR_BINARY_PROTOCOL)) {
+		php_error_docref(NULL, E_WARNING, "using touch command with binary protocol is not recommended with libmemcached versions below 1.0.18, please use ascii protocol or upgrade libmemcached");
+	}
+#endif
+	return memcached_touch(memc, key, key_len, expiration);
+}
+
+memcached_return php_memcached_touch_by_key(memcached_st *memc, const char *server_key, size_t server_key_len, const char *key, size_t key_len, time_t expiration)
+{
+#if defined(LIBMEMCACHED_VERSION_HEX) && LIBMEMCACHED_VERSION_HEX < 0x01000018
+	if (memcached_behavior_get(memc, MEMCACHED_BEHAVIOR_BINARY_PROTOCOL)) {
+		php_error_docref(NULL, E_WARNING, "using touch command with binary protocol is not recommended with libmemcached versions below 1.0.18, please use ascii protocol or upgrade libmemcached");
+	}
+#endif
+	return memcached_touch_by_key(memc, server_key, server_key_len, key, key_len, expiration);
+}
+

php_libmemcached_compat.h

@@ -22,6 +22,9 @@
 
 memcached_return php_memcached_exist (memcached_st *memc, zend_string *key);
 
+memcached_return php_memcached_touch(memcached_st *memc, const char *key, size_t key_len, time_t expiration);
+memcached_return php_memcached_touch_by_key(memcached_st *memc, const char *server_key, size_t server_key_len, const char *key, size_t key_len, time_t expiration);
+
 #if defined(LIBMEMCACHED_VERSION_HEX) && LIBMEMCACHED_VERSION_HEX >= 0x01000017
 typedef const memcached_instance_st * php_memcached_instance_st;
 #else

php_memcached.c

@@ -1081,7 +1081,7 @@ zend_bool s_memc_write_zval (php_memc_object_t *intern, php_memc_write_op op, ze
 			break;
 
 			case MEMC_OP_TOUCH:
-				status = memcached_touch_by_key(intern->memc, ZSTR_VAL(server_key), ZSTR_LEN(server_key), ZSTR_VAL(key), ZSTR_LEN(key), expiration);
+				status = php_memcached_touch_by_key(intern->memc, ZSTR_VAL(server_key), ZSTR_LEN(server_key), ZSTR_VAL(key), ZSTR_LEN(key), expiration);
 			break;
 
 			case MEMC_OP_ADD:
@@ -1113,7 +1113,7 @@ zend_bool s_memc_write_zval (php_memc_object_t *intern, php_memc_write_op op, ze
 			break;
 
 			case MEMC_OP_TOUCH:
-				status = memcached_touch(intern->memc, ZSTR_VAL(key), ZSTR_LEN(key), expiration);
+				status = php_memcached_touch(intern->memc, ZSTR_VAL(key), ZSTR_LEN(key), expiration);
 			break;
 
 			case MEMC_OP_ADD:
@@ -1959,15 +1959,6 @@ static void php_memc_store_impl(INTERNAL_FUNCTION_PARAMETERS, int op, zend_bool
 		}
 	}
 
-
-	if (op == MEMC_OP_TOUCH) {
-#if defined(LIBMEMCACHED_VERSION_HEX) && LIBMEMCACHED_VERSION_HEX < 0x01000016
-		if (memcached_behavior_get(intern->memc, MEMCACHED_BEHAVIOR_BINARY_PROTOCOL)) {
-			php_error_docref(NULL, E_WARNING, "using touch command with binary protocol is not recommended with libmemcached versions below 1.0.16");
-		}
-#endif
-	}
-
 	if (!s_memc_write_zval (intern, op, server_key, key, value, expiration)) {
 		RETURN_FALSE;
 	}

php_memcached.h

@@ -27,7 +27,7 @@
 # include "config.h"
 #endif
 
-#define PHP_MEMCACHED_VERSION "3.0.1"
+#define PHP_MEMCACHED_VERSION "3.0.3"
 
 #if defined(PHP_WIN32) && defined(MEMCACHED_EXPORTS)
 #define PHP_MEMCACHED_API __declspec(dllexport)

php_memcached_session.c

@@ -351,6 +351,7 @@ PS_OPEN_FUNC(memcached)
 				else {
 					efree(plist_key);
 					PS_SET_MOD_DATA(memc);
+					memcached_server_list_free(servers);
 					return SUCCESS;
 				}
 			}
@@ -435,8 +436,9 @@ PS_READ_FUNC(memcached)
 	payload = memcached_get(memc, key->val, key->len, &payload_len, &flags, &status);
 
 	if (status == MEMCACHED_SUCCESS) {
+		zend_bool *is_persistent = memcached_get_user_data(memc);
 		*val = zend_string_init(payload, payload_len, 0);
-		efree(payload);
+		pefree(payload, *is_persistent);
 		return SUCCESS;
 	} else if (status == MEMCACHED_NOTFOUND) {
 		*val = ZSTR_EMPTY_ALLOC();
@@ -542,7 +544,7 @@ PS_UPDATE_TIMESTAMP_FUNC(memcached)
 	memcached_st *memc = PS_GET_MOD_DATA();
 	time_t expiration = s_session_expiration(maxlifetime);
 
-	if (memcached_touch(memc, key->val, key->len, expiration) == MEMCACHED_FAILURE) {
+	if (php_memcached_touch(memc, key->val, key->len, expiration) == MEMCACHED_FAILURE) {
 		return FAILURE;
 	}
 	return SUCCESS;

tests/gh_155.phpt

@@ -4,15 +4,18 @@ Test for bug 155
 <?php 
 $min_version = "1.4.8";
 include dirname(__FILE__) . "/skipif.inc";
-if (Memcached::LIBMEMCACHED_VERSION_HEX < 0x01000016) die ('skip too old libmemcached');
+// The touch command in binary mode will work in libmemcached 1.0.16, but runs out the timeout clock
+// See https://github.com/php-memcached-dev/php-memcached/issues/310 for further explanation
+// The problem is fixed fully in libmemcached 1.0.18, so we'll focus tests on that version
+if (Memcached::LIBMEMCACHED_VERSION_HEX < 0x01000018) die ('skip too old libmemcached');
 ?>
 --FILE--
 <?php
 include dirname (__FILE__) . '/config.inc';
 
 $m = new Memcached ();
 
-$m->setOption(Memcached::OPT_BINARY_PROTOCOL,true);
+$m->setOption(Memcached::OPT_BINARY_PROTOCOL, true);
 $m->addServer(MEMC_SERVER_HOST, MEMC_SERVER_PORT);
 
 $key = 'bug_155_' . uniqid();

tests/gh_90.phpt

@@ -12,7 +12,7 @@ $memcached = memc_get_instance (array (
 // Create a key for use as a lock.  If this key already exists, wait till it doesn't exist.
 {
     $key = 'LockKey';
-    $lockToken = mt_rand(0, pow(2, 32)); //Random value betwen 0 and 2^32 for ownership verification
+    $lockToken = mt_rand(0, mt_getrandmax()); //Random value for ownership verification
 
     while (true)
     {
@@ -88,4 +88,4 @@ array(10) {
   int(1)
   ["9_%s"]=>
   int(1)
-}
+}

tests/incrdecr.phpt

@@ -42,10 +42,10 @@ echo $php_errormsg, "\n";
 var_dump($m->get('foo'));
 
 echo "Enormous offset\n";
-$m->increment('foo', 4294967296);
+$m->increment('foo', 0x7f000000);
 var_dump($m->get('foo'));
 
-$m->decrement('foo', 4294967296);
+$m->decrement('foo', 0x7f000000);
 var_dump($m->get('foo'));
 
 --EXPECT--
@@ -68,5 +68,5 @@ int(1)
 Memcached::decrement(): offset cannot be a negative value
 int(1)
 Enormous offset
-int(4294967297)
+int(2130706433)
 int(1)

tests/incrdecr_64.phpt

@@ -0,0 +1,39 @@
+--TEST--
+64-bit Memcached::increment() decrement() incrementByKey() decrementByKey()
+--SKIPIF--
+<?php
+include "skipif.inc";
+if (PHP_INT_SIZE < 8) die("skip valid for 64-bit PHP only");
+?>
+--FILE--
+<?php
+include dirname (__FILE__) . '/config.inc';
+$m = memc_get_instance ();
+
+echo "Normal\n";
+$m->set('foo', 1);
+var_dump($m->get('foo'));
+
+echo "Enormous offset 64-bit\n";
+$m->increment('foo', 0x100000000);
+var_dump($m->get('foo'));
+
+$m->decrement('foo', 0x100000000);
+var_dump($m->get('foo'));
+
+echo "Enormous offset 64-bit by key\n";
+$m->incrementByKey('foo', 'foo', 0x100000000);
+var_dump($m->get('foo'));
+
+$m->decrementByKey('foo', 'foo', 0x100000000);
+var_dump($m->get('foo'));
+
+--EXPECT--
+Normal
+int(1)
+Enormous offset 64-bit
+int(4294967297)
+int(1)
+Enormous offset 64-bit by key
+int(4294967297)
+int(1)

tests/incrdecr_bykey.phpt

@@ -39,10 +39,10 @@ echo $php_errormsg, "\n";
 var_dump($m->get('foo'));
 
 echo "Enormous offset\n";
-$m->incrementByKey('foo', 'foo', 4294967296);
+$m->incrementByKey('foo', 'foo', 0x7f000000);
 var_dump($m->get('foo'));
 
-$m->decrementByKey('foo', 'foo', 4294967296);
+$m->decrementByKey('foo', 'foo', 0x7f000000);
 var_dump($m->get('foo'));
 
 --EXPECT--
@@ -62,5 +62,5 @@ int(1)
 Memcached::decrementByKey(): offset cannot be a negative value
 int(1)
 Enormous offset
-int(4294967297)
+int(2130706433)
 int(1)

tests/session_basic.phpt

@@ -7,6 +7,7 @@ if (!Memcached::HAVE_SESSION) print "skip";
 ?>
 --INI--
 session.save_handler = memcached
+memcached.sess_binary_protocol = Off
 --FILE--
 <?php
 include dirname (__FILE__) . '/config.inc';