Merge pull request #126 from doctrine/hotfix/#113-testing-windows-file-path-length-limitations-1-5

Hotfix/#113 testing windows file path length limitations Backport #122

Author: Bill Schaller

.travis.yml

@@ -24,7 +24,7 @@ services:
 before_install:
  - if [[ $TRAVIS_PHP_VERSION != 'hhvm' && $TRAVIS_PHP_VERSION != '7.0' ]]; then pecl install riak-beta; fi;
  - if [[ $TRAVIS_PHP_VERSION =~ 5.[34] ]] ; then echo 'extension="apc.so"' >> ./tests/travis/php.ini; fi;
- - if [[ $TRAVIS_PHP_VERSION =~ 5.[56] ]] ; then echo yes | pecl install apcu; fi;
+ - if [[ $TRAVIS_PHP_VERSION =~ 5.[56] ]] ; then echo yes | pecl install apcu-4.0.10; fi;
  - if [[ $TRAVIS_PHP_VERSION = 7.* ]] ; then pecl config-set preferred_state beta; echo yes | pecl install apcu; fi;
  - if [[ $TRAVIS_PHP_VERSION != 'hhvm' ]]; then phpenv config-add ./tests/travis/php.ini; fi;
 

lib/Doctrine/Common/Cache/FileCache.php

@@ -137,7 +137,7 @@ protected function getFilename($id)
  if (
  '' === $id
  || ((strlen($id) * 2 + $this->extensionStringLength) > 255)
- || (($this->isRunningOnWindows && $this->directoryStringLength + 4 + strlen($id) * 2 + $this->extensionStringLength) > 259)
+ || ($this->isRunningOnWindows && ($this->directoryStringLength + 4 + strlen($id) * 2 + $this->extensionStringLength) > 259)
  ) {
  // Most filesystems have a limit of 255 chars for each path component. On Windows the the whole path is limited
  // to 260 chars (including terminating null char). Using long UNC ("\\?\" prefix) does not work with the PHP API.

tests/Doctrine/Tests/Common/Cache/FileCacheTest.php

@@ -91,7 +91,7 @@ public function testNonIntUmaskThrowsInvalidArgumentException()
 
  $this->getMock(
  'Doctrine\Common\Cache\FileCache',
- array(),
+ array('doFetch', 'doContains', 'doSave'),
  array('', '', 'invalid')
  );
  }
@@ -129,4 +129,86 @@ public function testGetExtensionReturnsExtensionString()
 
  $this->assertEquals($extension, $actualExtension);
  }
+
+ /**
+ * @runInSeparateProcess
+ *
+ * @covers \Doctrine\Common\Cache\FileCache::getFilename
+ */
+ public function testWindowsPathLengthLimitationsAreCorrectlyRespected()
+ {
+ if (! defined('PHP_WINDOWS_VERSION_BUILD')) {
+ define('PHP_WINDOWS_VERSION_BUILD', 'Yes, this is the "usual suspect", with the usual limitations');
+ }
+
+ // Not using __DIR__ because it can get screwed up when xdebug debugger is attached.
+ $basePath = realpath(sys_get_temp_dir());
+
+ // If the base path length is even, pad it with '/aa' so it's odd.
+ // That way we can test a path of length 260
+ // 260 characters is too large - null terminator is included in allowable length
+ if (!(strlen($basePath) % 1)) {
+ $basePath .= DIRECTORY_SEPARATOR . "aa";
+ }
+
+ $fileCache = $this->getMockForAbstractClass(
+ 'Doctrine\Common\Cache\FileCache',
+ array($basePath, '.doctrine.cache')
+ );
+
+ $baseDirLength = strlen($basePath);
+ $extensionLength = strlen('.doctrine.cache');
+ $windowsPathMaxLength = 259; // 260 bytes including null terminator
+ $maxKeyLength = $windowsPathMaxLength - ($baseDirLength + $extensionLength);
+
+ self::assertSame('61', bin2hex('a'), '(added just for clarity and system integrity check)');
+
+ $tooLongKey = str_repeat('a', ($maxKeyLength / 2) - 1); // note: 1 char because reasons, ok?
+ $fittingKey = str_repeat('a', ($maxKeyLength / 2) - 2); // note: 2 chars due to path separator added as well
+
+ $tooLongKeyHash = hash('sha256', $tooLongKey);
+ $fittingKeyHash = hash('sha256', $fittingKey);
+
+ $getFileName = new \ReflectionMethod($fileCache, 'getFilename');
+
+ $getFileName->setAccessible(true);
+
+ $this->assertEquals(
+ $windowsPathMaxLength + 1,
+ strlen($basePath
+ . DIRECTORY_SEPARATOR
+ . substr($tooLongKeyHash, 0, 2)
+ . DIRECTORY_SEPARATOR
+ . bin2hex($tooLongKey)
+ . '.doctrine.cache'),
+ sprintf('Key expected to be too long is %d characters long', $windowsPathMaxLength + 1)
+ );
+
+ $this->assertSame(
+ $basePath . DIRECTORY_SEPARATOR . substr($tooLongKeyHash, 0, 2) . DIRECTORY_SEPARATOR . '_' . $tooLongKeyHash . '.doctrine.cache',
+ $getFileName->invoke($fileCache, $tooLongKey),
+ 'Keys over the limit of the allowed length are hashed correctly'
+ );
+
+ $this->assertLessThan(
+ $windowsPathMaxLength,
+ strlen($basePath
+ . DIRECTORY_SEPARATOR
+ . substr($fittingKeyHash, 0, 2)
+ . DIRECTORY_SEPARATOR
+ . bin2hex($fittingKey)
+ . '.doctrine.cache'),
+ sprintf(
+ 'Key expected to fit the length limit(%d) is less than %d characters long',
+ $windowsPathMaxLength,
+ $windowsPathMaxLength
+ )
+ );
+
+ $this->assertSame(
+ $basePath . DIRECTORY_SEPARATOR . substr($fittingKeyHash, 0, 2) . DIRECTORY_SEPARATOR . bin2hex($fittingKey) . '.doctrine.cache',
+ $getFileName->invoke($fileCache, $fittingKey),
+ 'Keys below limit of the allowed length are used directly, unhashed'
+ );
+ }
 }