diff options
| -rw-r--r-- | .travis.yml | 1 | ||||
| -rw-r--r-- | phpBB/docs/coding-guidelines.html | 6 | ||||
| -rw-r--r-- | phpBB/phpbb/cache/driver/memcache.php | 122 | ||||
| -rw-r--r-- | phpBB/phpbb/cache/driver/memcached.php | 22 | ||||
| -rw-r--r-- | tests/RUNNING_TESTS.md | 15 | ||||
| -rw-r--r-- | tests/cache/memcached_test.php | 65 | ||||
| -rw-r--r-- | tests/test_framework/phpbb_test_case_helpers.php | 20 | ||||
| -rw-r--r-- | travis/phpunit-mysqli-travis.xml | 1 | ||||
| -rw-r--r-- | travis/phpunit-postgres-travis.xml | 1 | ||||
| -rw-r--r-- | travis/phpunit-sqlite3-travis.xml | 1 | ||||
| -rwxr-xr-x | travis/setup-php-extensions.sh | 3 | 
11 files changed, 128 insertions, 129 deletions
| diff --git a/.travis.yml b/.travis.yml index d6fc46c585..82ddd01158 100644 --- a/.travis.yml +++ b/.travis.yml @@ -31,6 +31,7 @@ services:    - redis-server    - postgresql    - mysql +  - memcached  install:    - travis/setup-phpbb.sh $DB $TRAVIS_PHP_VERSION $NOTESTS diff --git a/phpBB/docs/coding-guidelines.html b/phpBB/docs/coding-guidelines.html index 6cf647c55f..ffa2112771 100644 --- a/phpBB/docs/coding-guidelines.html +++ b/phpBB/docs/coding-guidelines.html @@ -234,9 +234,9 @@ PHPBB_USE_BOARD_URL_PATH   (use generate_board_url() for image paths instead of  PHPBB_DISABLE_ACP_EDITOR   (disable ACP style editor for templates)  PHPBB_DISABLE_CONFIG_CHECK (disable ACP config.php writeable check) -PHPBB_ACM_MEMCACHE_PORT     (overwrite memcached port, default is 11211) -PHPBB_ACM_MEMCACHE_COMPRESS (overwrite memcached compress setting, default is disabled) -PHPBB_ACM_MEMCACHE_HOST     (overwrite memcached host name, default is localhost) +PHPBB_ACM_MEMCACHED_PORT     (overwrite memcached port, default is 11211) +PHPBB_ACM_MEMCACHED_COMPRESS (overwrite memcached compress setting, default is disabled) +PHPBB_ACM_MEMCACHED_HOST     (overwrite memcached host name, default is localhost)  PHPBB_ACM_REDIS_HOST        (overwrite redis host name, default is localhost)  PHPBB_ACM_REDIS_PORT        (overwrite redis port, default is 6379) diff --git a/phpBB/phpbb/cache/driver/memcache.php b/phpBB/phpbb/cache/driver/memcache.php deleted file mode 100644 index 57f138f574..0000000000 --- a/phpBB/phpbb/cache/driver/memcache.php +++ /dev/null @@ -1,122 +0,0 @@ -<?php -/** -* -* This file is part of the phpBB Forum Software package. -* -* @copyright (c) phpBB Limited <https://www.phpbb.com> -* @license GNU General Public License, version 2 (GPL-2.0) -* -* For full copyright and license information, please see -* the docs/CREDITS.txt file. -* -*/ - -namespace phpbb\cache\driver; - -if (!defined('PHPBB_ACM_MEMCACHE_PORT')) -{ -	define('PHPBB_ACM_MEMCACHE_PORT', 11211); -} - -if (!defined('PHPBB_ACM_MEMCACHE_COMPRESS')) -{ -	define('PHPBB_ACM_MEMCACHE_COMPRESS', false); -} - -if (!defined('PHPBB_ACM_MEMCACHE_HOST')) -{ -	define('PHPBB_ACM_MEMCACHE_HOST', 'localhost'); -} - -if (!defined('PHPBB_ACM_MEMCACHE')) -{ -	//can define multiple servers with host1/port1,host2/port2 format -	define('PHPBB_ACM_MEMCACHE', PHPBB_ACM_MEMCACHE_HOST . '/' . PHPBB_ACM_MEMCACHE_PORT); -} - -/** -* ACM for Memcached -*/ -class memcache extends \phpbb\cache\driver\memory -{ -	var $extension = 'memcache'; - -	var $memcache; -	var $flags = 0; - -	function __construct() -	{ -		// Call the parent constructor -		parent::__construct(); - -		$this->memcache = new \Memcache; -		foreach (explode(',', PHPBB_ACM_MEMCACHE) as $u) -		{ -			preg_match('#(.*)/(\d+)#', $u, $parts); -			$this->memcache->addServer(trim($parts[1]), (int) trim($parts[2])); -		} -		$this->flags = (PHPBB_ACM_MEMCACHE_COMPRESS) ? MEMCACHE_COMPRESSED : 0; -	} - -	/** -	* {@inheritDoc} -	*/ -	function unload() -	{ -		parent::unload(); - -		$this->memcache->close(); -	} - -	/** -	* {@inheritDoc} -	*/ -	function purge() -	{ -		$this->memcache->flush(); - -		parent::purge(); -	} - -	/** -	* Fetch an item from the cache -	* -	* @access protected -	* @param string $var Cache key -	* @return mixed Cached data -	*/ -	function _read($var) -	{ -		return $this->memcache->get($this->key_prefix . $var); -	} - -	/** -	* Store data in the cache -	* -	* @access protected -	* @param string $var Cache key -	* @param mixed $data Data to store -	* @param int $ttl Time-to-live of cached data -	* @return bool True if the operation succeeded -	*/ -	function _write($var, $data, $ttl = 2592000) -	{ -		if (!$this->memcache->replace($this->key_prefix . $var, $data, $this->flags, $ttl)) -		{ -			return $this->memcache->set($this->key_prefix . $var, $data, $this->flags, $ttl); -		} -		return true; -	} - -	/** -	* Remove an item from the cache -	* -	* @access protected -	* @param string $var Cache key -	* @return bool True if the operation succeeded -	*/ -	function _delete($var) -	{ -		return $this->memcache->delete($this->key_prefix . $var); -	} -} diff --git a/phpBB/phpbb/cache/driver/memcached.php b/phpBB/phpbb/cache/driver/memcached.php index 7d66759ec2..fbb587a369 100644 --- a/phpBB/phpbb/cache/driver/memcached.php +++ b/phpBB/phpbb/cache/driver/memcached.php @@ -50,12 +50,16 @@ class memcached extends \phpbb\cache\driver\memory  	/**  	 * Memcached constructor +	 * +	 * @param string $memcached_servers Memcached servers string (optional)  	 */ -	public function __construct() +	public function __construct($memcached_servers = '')  	{  		// Call the parent constructor  		parent::__construct(); +		$memcached_servers = $memcached_servers ?: PHPBB_ACM_MEMCACHED; +  		$this->memcached = new \Memcached();  		$this->memcached->setOption(\Memcached::OPT_BINARY_PROTOCOL, true);  		// Memcached defaults to using compression, disable if we don't want @@ -65,10 +69,20 @@ class memcached extends \phpbb\cache\driver\memory  			$this->memcached->setOption(\Memcached::OPT_COMPRESSION, false);  		} -		foreach (explode(',', PHPBB_ACM_MEMCACHED) as $u) +		$server_list = []; +		foreach (explode(',', $memcached_servers) as $u) +		{ +			if (preg_match('#(.*)/(\d+)#', $u, $parts)) +			{ +				$server_list[] = [trim($parts[1]), (int) trim($parts[2])]; +			} +		} + +		$this->memcached->addServers($server_list); + +		if (empty($server_list) || empty($this->memcached->getStats()))  		{ -			preg_match('#(.*)/(\d+)#', $u, $parts); -			$this->memcached->addServer(trim($parts[1]), (int) trim($parts[2])); +			trigger_error('Could not connect to memcached server(s).');  		}  	} diff --git a/tests/RUNNING_TESTS.md b/tests/RUNNING_TESTS.md index 516541151c..54db823b4a 100644 --- a/tests/RUNNING_TESTS.md +++ b/tests/RUNNING_TESTS.md @@ -109,6 +109,21 @@ Or via environment variables as follows:      $ PHPBB_TEST_REDIS_HOST=localhost PHPBB_TEST_REDIS_PORT=6379 phpunit +Memcached +--------- + +In order to run tests for the memcached cache driver, at least one of memcached +host or port must be specified in the test configuration. This can be done via +test_config.php as follows: + +    <?php +    $phpbb_memcached_host = 'localhost'; +    $phpbb_memcached_port = '11211'; + +Or via environment variables as follows: + +    $ PHPBB_TEST_MEMCACHED_HOST=localhost PHPBB_TEST_MEMCACHED_PORT=11211 phpunit +  Running  ======= diff --git a/tests/cache/memcached_test.php b/tests/cache/memcached_test.php new file mode 100644 index 0000000000..650b72ea18 --- /dev/null +++ b/tests/cache/memcached_test.php @@ -0,0 +1,65 @@ +<?php +/** + * + * This file is part of the phpBB Forum Software package. + * + * @copyright (c) phpBB Limited <https://www.phpbb.com> + * @license GNU General Public License, version 2 (GPL-2.0) + * + * For full copyright and license information, please see + * the docs/CREDITS.txt file. + * + */ + +require_once dirname(__FILE__) . '/common_test_case.php'; + +class phpbb_cache_memcached_driver_test extends \phpbb_cache_common_test_case +{ +	protected static $config; + +	public function getDataSet() +	{ +		return $this->createXMLDataSet(dirname(__FILE__) . '/fixtures/config.xml'); +	} + +	static public function setUpBeforeClass() +	{ +		if (!extension_loaded('memcached')) +		{ +			self::markTestSkipped('memcached extension is not loaded'); +		} + +		$config = phpbb_test_case_helpers::get_test_config(); +		if (isset($config['memcached_host']) || isset($config['memcached_port'])) +		{ +			$host = isset($config['memcached_host']) ? $config['memcached_host'] : 'localhost'; +			$port = isset($config['memcached_port']) ? $config['memcached_port'] : 11211; +			self::$config = array('host' => $host, 'port' => $port); +		} +		else +		{ +			self::markTestSkipped('Test memcached host/port is not specified'); +		} + +		$memcached = new \Memcached(); +		$memcached->addServer(self::$config['host'], self::$config['port']); +		if (empty($memcached->getStats())) +		{ +			self::markTestSkipped('Test memcached server is not available'); +		} + +		parent::setUpBeforeClass(); +	} + +	protected function setUp(): void +	{ +		global $phpbb_root_path, $phpbb_container; + +		parent::setUp(); + +		$phpbb_container = new phpbb_mock_container_builder(); +		$phpbb_container->setParameter('core.cache_dir', $phpbb_root_path . 'cache/' . PHPBB_ENVIRONMENT . '/'); +		$this->driver = new \phpbb\cache\driver\memcached(self::$config['host'] . '/' . self::$config['port']); +		$this->driver->purge(); +	} +} diff --git a/tests/test_framework/phpbb_test_case_helpers.php b/tests/test_framework/phpbb_test_case_helpers.php index 807a64d810..9a2ea275d0 100644 --- a/tests/test_framework/phpbb_test_case_helpers.php +++ b/tests/test_framework/phpbb_test_case_helpers.php @@ -173,6 +173,16 @@ class phpbb_test_case_helpers  			{  				$config['fulltext_sphinx_id'] = $fulltext_sphinx_id;  			} + +			if (isset($phpbb_memcached_host)) +			{ +				$config['memcached_host'] = $phpbb_memcached_host; +			} + +			if (isset($phpbb_memcached_port)) +			{ +				$config['memcached_port'] = $phpbb_memcached_port; +			}  		}  		if (isset($_SERVER['PHPBB_TEST_DBMS'])) @@ -205,6 +215,16 @@ class phpbb_test_case_helpers  			$config['redis_port'] = $_SERVER['PHPBB_TEST_REDIS_PORT'];  		} +		if (isset($_SERVER['PHPBB_TEST_MEMCACHED_HOST'])) +		{ +			$config['memcached_host'] = $_SERVER['PHPBB_TEST_MEMCACHED_HOST']; +		} + +		if (isset($_SERVER['PHPBB_TEST_MEMCACHED_PORT'])) +		{ +			$config['memcached_port'] = $_SERVER['PHPBB_TEST_MEMCACHED_PORT']; +		} +  		return $config;  	} diff --git a/travis/phpunit-mysqli-travis.xml b/travis/phpunit-mysqli-travis.xml index d2284086b9..0f064ab996 100644 --- a/travis/phpunit-mysqli-travis.xml +++ b/travis/phpunit-mysqli-travis.xml @@ -38,6 +38,7 @@  		<server name="PHPBB_TEST_DBUSER" value="root" />  		<server name="PHPBB_TEST_DBPASSWD" value="" />  		<server name="PHPBB_TEST_REDIS_HOST" value="localhost" /> +		<server name="PHPBB_TEST_MEMCACHED_HOST" value="localhost" />  		<server name="PHPBB_TEST_TABLE_PREFIX" value="phpbb_"/>  		<server name="PHPBB_FUNCTIONAL_URL" value="http://localhost/" />  	</php> diff --git a/travis/phpunit-postgres-travis.xml b/travis/phpunit-postgres-travis.xml index 6faab4d61a..f9b8a6f595 100644 --- a/travis/phpunit-postgres-travis.xml +++ b/travis/phpunit-postgres-travis.xml @@ -38,6 +38,7 @@  		<server name="PHPBB_TEST_DBUSER" value="postgres" />  		<server name="PHPBB_TEST_DBPASSWD" value="" />  		<server name="PHPBB_TEST_REDIS_HOST" value="localhost" /> +		<server name="PHPBB_TEST_MEMCACHED_HOST" value="localhost" />  		<server name="PHPBB_TEST_TABLE_PREFIX" value="phpbb_"/>  		<server name="PHPBB_FUNCTIONAL_URL" value="http://localhost/" />  	</php> diff --git a/travis/phpunit-sqlite3-travis.xml b/travis/phpunit-sqlite3-travis.xml index 633963c9fb..1b1fa24e7d 100644 --- a/travis/phpunit-sqlite3-travis.xml +++ b/travis/phpunit-sqlite3-travis.xml @@ -38,6 +38,7 @@  		<!--server name="PHPBB_TEST_DBUSER" value="" /-->  		<!--server name="PHPBB_TEST_DBPASSWD" value="" /-->  		<server name="PHPBB_TEST_REDIS_HOST" value="localhost" /> +		<server name="PHPBB_TEST_MEMCACHED_HOST" value="localhost" />  		<server name="PHPBB_TEST_TABLE_PREFIX" value="phpbb_"/>  		<server name="PHPBB_FUNCTIONAL_URL" value="http://localhost/" />  	</php> diff --git a/travis/setup-php-extensions.sh b/travis/setup-php-extensions.sh index 851704213e..0fcddb044f 100755 --- a/travis/setup-php-extensions.sh +++ b/travis/setup-php-extensions.sh @@ -57,6 +57,9 @@ fi  # Disable xdebug on travis  phpenv config-rm xdebug.ini || true +# memcached +register_php_extension memcached "$php_ini_file" +  # redis  # Disabled redis for now as it causes travis to fail  # git clone git://github.com/nicolasff/phpredis.git redis | 
