Merge pull request #18386 from nextcloud/backport/18236/stable17

[stable17] Allow to detect mimetype by content
This commit is contained in:
Roeland Jago Douma 2019-12-12 23:04:26 +01:00 committed by GitHub
commit 0a172d08bb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 187 additions and 165 deletions

View File

@ -44,8 +44,9 @@ abstract class AbstractStringCheck implements ICheck {
/** /**
* @param IStorage $storage * @param IStorage $storage
* @param string $path * @param string $path
* @param bool $isDir
*/ */
public function setFileInfo(IStorage $storage, $path) { public function setFileInfo(IStorage $storage, $path, $isDir = false) {
// Nothing changes here with a different path // Nothing changes here with a different path
} }

View File

@ -58,13 +58,19 @@ class FileMimeType extends AbstractStringCheck {
/** /**
* @param IStorage $storage * @param IStorage $storage
* @param string $path * @param string $path
* @param bool $isDir
*/ */
public function setFileInfo(IStorage $storage, $path) { public function setFileInfo(IStorage $storage, $path, $isDir = false) {
$this->storage = $storage; $this->storage = $storage;
$this->path = $path; $this->path = $path;
if (!isset($this->mimeType[$this->storage->getId()][$this->path]) if (!isset($this->mimeType[$this->storage->getId()][$this->path])
|| $this->mimeType[$this->storage->getId()][$this->path] === '') { || $this->mimeType[$this->storage->getId()][$this->path] === '') {
$this->mimeType[$this->storage->getId()][$this->path] = null;
if ($isDir) {
$this->mimeType[$this->storage->getId()][$this->path] = 'httpd/unix-directory';
} else {
$this->mimeType[$this->storage->getId()][$this->path] = null;
}
} }
} }
@ -103,93 +109,24 @@ class FileMimeType extends AbstractStringCheck {
return $this->cacheAndReturnMimeType($this->storage->getId(), $this->path, 'httpd/unix-directory'); return $this->cacheAndReturnMimeType($this->storage->getId(), $this->path, 'httpd/unix-directory');
} }
if ($this->isWebDAVRequest()) { if ($this->storage->file_exists($this->path)) {
$path = $this->storage->getLocalFile($this->path);
$mimeType = $this->mimeTypeDetector->detectContent($path);
return $this->cacheAndReturnMimeType($this->storage->getId(), $this->path, $mimeType);
}
if ($this->isWebDAVRequest() || $this->isPublicWebDAVRequest()) {
// Creating a folder // Creating a folder
if ($this->request->getMethod() === 'MKCOL') { if ($this->request->getMethod() === 'MKCOL') {
return $this->cacheAndReturnMimeType($this->storage->getId(), $this->path, 'httpd/unix-directory'); return 'httpd/unix-directory';
}
if ($this->request->getMethod() === 'PUT' || $this->request->getMethod() === 'MOVE') {
if ($this->request->getMethod() === 'MOVE') {
$mimeType = $this->mimeTypeDetector->detectPath($this->path);
} else {
$path = $this->request->getPathInfo();
$mimeType = $this->mimeTypeDetector->detectPath($path);
}
return $this->cacheAndReturnMimeType($this->storage->getId(), $this->path, $mimeType);
}
} else if ($this->isPublicWebDAVRequest()) {
if ($this->request->getMethod() === 'PUT') {
$path = $this->request->getPathInfo();
if (strpos($path, '/webdav/') === 0) {
$path = substr($path, strlen('/webdav'));
}
$path = $this->path . $path;
$mimeType = $this->mimeTypeDetector->detectPath($path);
return $this->cacheAndReturnMimeType($this->storage->getId(), $path, $mimeType);
} }
} }
if (in_array($this->request->getMethod(), ['POST', 'PUT'])) { // We do not cache this, as the file did not exist yet.
$files = $this->request->getUploadedFile('files'); // In case it does in the future, we will check with detectContent()
if (isset($files['type'][0])) { // again to get the real mimetype of the content, rather than
$mimeType = $files['type'][0]; // guessing it from the path.
if ($mimeType === 'application/octet-stream') { return $this->mimeTypeDetector->detectPath($this->path);
// Maybe not...
$mimeTypeTest = $this->mimeTypeDetector->detectPath($files['name'][0]);
if ($mimeTypeTest !== 'application/octet-stream' && $mimeTypeTest !== false) {
$mimeType = $mimeTypeTest;
} else {
$mimeTypeTest = $this->mimeTypeDetector->detect($files['tmp_name'][0]);
if ($mimeTypeTest !== 'application/octet-stream' && $mimeTypeTest !== false) {
$mimeType = $mimeTypeTest;
}
}
}
return $this->cacheAndReturnMimeType($this->storage->getId(), $this->path, $mimeType);
}
}
$mimeType = $this->storage->getMimeType($this->path);
if ($mimeType === 'application/octet-stream') {
$mimeType = $this->detectMimetypeFromPath();
}
return $this->cacheAndReturnMimeType($this->storage->getId(), $this->path, $mimeType);
}
/**
* @return string
*/
protected function detectMimetypeFromPath() {
$mimeType = $this->mimeTypeDetector->detectPath($this->path);
if ($mimeType !== 'application/octet-stream' && $mimeType !== false) {
return $mimeType;
}
if ($this->storage->instanceOfStorage('\OC\Files\Storage\Local')
|| $this->storage->instanceOfStorage('\OC\Files\Storage\Home')
|| $this->storage->instanceOfStorage('\OC\Files\ObjectStore\HomeObjectStoreStorage')) {
$localFile = $this->storage->getLocalFile($this->path);
if ($localFile !== false) {
$mimeType = $this->mimeTypeDetector->detect($localFile);
if ($mimeType !== false) {
return $mimeType;
}
}
return 'application/octet-stream';
} else {
$handle = $this->storage->fopen($this->path, 'r');
$data = fread($handle, 8024);
fclose($handle);
$mimeType = $this->mimeTypeDetector->detectString($data);
if ($mimeType !== false) {
return $mimeType;
}
return 'application/octet-stream';
}
} }
/** /**

View File

@ -49,8 +49,9 @@ class FileName extends AbstractStringCheck {
/** /**
* @param IStorage $storage * @param IStorage $storage
* @param string $path * @param string $path
* @param bool $isDir
*/ */
public function setFileInfo(IStorage $storage, $path) { public function setFileInfo(IStorage $storage, $path, $isDir = false) {
$this->storage = $storage; $this->storage = $storage;
$this->path = $path; $this->path = $path;
} }

View File

@ -51,8 +51,9 @@ class FileSize implements ICheck {
/** /**
* @param IStorage $storage * @param IStorage $storage
* @param string $path * @param string $path
* @param bool $isDir
*/ */
public function setFileInfo(IStorage $storage, $path) { public function setFileInfo(IStorage $storage, $path, $isDir = false) {
} }
/** /**

View File

@ -68,8 +68,9 @@ class FileSystemTags implements ICheck {
/** /**
* @param IStorage $storage * @param IStorage $storage
* @param string $path * @param string $path
* @param bool $isDir
*/ */
public function setFileInfo(IStorage $storage, $path) { public function setFileInfo(IStorage $storage, $path, $isDir = false) {
$this->storage = $storage; $this->storage = $storage;
$this->path = $path; $this->path = $path;
} }

View File

@ -47,8 +47,9 @@ class RequestRemoteAddress implements ICheck {
/** /**
* @param IStorage $storage * @param IStorage $storage
* @param string $path * @param string $path
* @param bool $isDir
*/ */
public function setFileInfo(IStorage $storage, $path) { public function setFileInfo(IStorage $storage, $path, $isDir = false) {
// A different path doesn't change time, so nothing to do here. // A different path doesn't change time, so nothing to do here.
} }

View File

@ -52,8 +52,9 @@ class RequestTime implements ICheck {
/** /**
* @param IStorage $storage * @param IStorage $storage
* @param string $path * @param string $path
* @param bool $isDir
*/ */
public function setFileInfo(IStorage $storage, $path) { public function setFileInfo(IStorage $storage, $path, $isDir = false) {
// A different path doesn't change time, so nothing to do here. // A different path doesn't change time, so nothing to do here.
} }

View File

@ -60,8 +60,9 @@ class UserGroupMembership implements ICheck {
/** /**
* @param IStorage $storage * @param IStorage $storage
* @param string $path * @param string $path
* @param bool $isDir
*/ */
public function setFileInfo(IStorage $storage, $path) { public function setFileInfo(IStorage $storage, $path, $isDir = false) {
// A different path doesn't change group memberships, so nothing to do here. // A different path doesn't change group memberships, so nothing to do here.
} }

View File

@ -184,11 +184,14 @@ class Detection implements IMimeTypeDetector {
if (strpos($fileName, '.') > 0) { if (strpos($fileName, '.') > 0) {
// remove versioning extension: name.v1508946057 and transfer extension: name.ocTransferId2057600214.part // remove versioning extension: name.v1508946057 and transfer extension: name.ocTransferId2057600214.part
$fileName = preg_replace('!((\.v\d+)|((.ocTransferId\d+)?.part))$!', '', $fileName); $fileName = preg_replace('!((\.v\d+)|((\.ocTransferId\d+)?\.part))$!', '', $fileName);
//try to guess the type by the file extension //try to guess the type by the file extension
$extension = strtolower(strrchr($fileName, '.')); $extension = strrchr($fileName, '.');
$extension = substr($extension, 1); //remove leading . if ($extension !== false) {
$extension = strtolower($extension);
$extension = substr($extension, 1); //remove leading .
}
return (isset($this->mimetypes[$extension]) && isset($this->mimetypes[$extension][0])) return (isset($this->mimetypes[$extension]) && isset($this->mimetypes[$extension][0]))
? $this->mimetypes[$extension][0] ? $this->mimetypes[$extension][0]
: 'application/octet-stream'; : 'application/octet-stream';
@ -198,12 +201,12 @@ class Detection implements IMimeTypeDetector {
} }
/** /**
* detect mimetype based on both filename and content * detect mimetype only based on the content of file
*
* @param string $path * @param string $path
* @return string * @return string
* @since 18.0.0
*/ */
public function detect($path) { public function detectContent(string $path): string {
$this->loadMappings(); $this->loadMappings();
if (@is_dir($path)) { if (@is_dir($path)) {
@ -211,41 +214,72 @@ class Detection implements IMimeTypeDetector {
return "httpd/unix-directory"; return "httpd/unix-directory";
} }
$mimeType = $this->detectPath($path); if (function_exists('finfo_open')
&& function_exists('finfo_file')
if ($mimeType === 'application/octet-stream' and function_exists('finfo_open') && $finfo = finfo_open(FILEINFO_MIME)) {
and function_exists('finfo_file') and $finfo = finfo_open(FILEINFO_MIME) $info = @finfo_file($finfo, $path);
) {
$info = @strtolower(finfo_file($finfo, $path));
finfo_close($finfo); finfo_close($finfo);
if ($info) { if ($info) {
$info = strtolower($info);
$mimeType = strpos($info, ';') !== false ? substr($info, 0, strpos($info, ';')) : $info; $mimeType = strpos($info, ';') !== false ? substr($info, 0, strpos($info, ';')) : $info;
return empty($mimeType) ? 'application/octet-stream' : $mimeType; $mimeType = $this->getSecureMimeType($mimeType);
if ($mimeType !== 'application/octet-stream') {
return $mimeType;
}
} }
} }
$isWrapped = (strpos($path, '://') !== false) and (substr($path, 0, 7) === 'file://');
if (!$isWrapped and $mimeType === 'application/octet-stream' && function_exists("mime_content_type")) { if (strpos($path, '://') !== false && strpos($path, 'file://') === 0) {
// Is the file wrapped in a stream?
return 'application/octet-stream';
}
if (function_exists('mime_content_type')) {
// use mime magic extension if available // use mime magic extension if available
$mimeType = mime_content_type($path); $mimeType = mime_content_type($path);
if ($mimeType !== false) {
$mimeType = $this->getSecureMimeType($mimeType);
if ($mimeType !== 'application/octet-stream') {
return $mimeType;
}
}
} }
if (!$isWrapped and $mimeType === 'application/octet-stream' && \OC_Helper::canExecute("file")) {
if (\OC_Helper::canExecute('file')) {
// it looks like we have a 'file' command, // it looks like we have a 'file' command,
// lets see if it does have mime support // lets see if it does have mime support
$path = escapeshellarg($path); $path = escapeshellarg($path);
$fp = popen("file -b --mime-type $path 2>/dev/null", "r"); $fp = popen("test -f $path && file -b --mime-type $path", 'r');
$reply = fgets($fp); $mimeType = fgets($fp);
pclose($fp); pclose($fp);
//trim the newline if ($mimeType !== false) {
$mimeType = trim($reply); //trim the newline
$mimeType = trim($mimeType);
if (empty($mimeType)) { $mimeType = $this->getSecureMimeType($mimeType);
$mimeType = 'application/octet-stream'; if ($mimeType !== 'application/octet-stream') {
return $mimeType;
}
} }
} }
return $mimeType; return 'application/octet-stream';
}
/**
* detect mimetype based on both filename and content
*
* @param string $path
* @return string
*/
public function detect($path) {
$mimeType = $this->detectPath($path);
if ($mimeType !== 'application/octet-stream') {
return $mimeType;
}
return $this->detectContent($path);
} }
/** /**

View File

@ -39,9 +39,17 @@ interface IMimeTypeDetector {
* @param string $path * @param string $path
* @return string * @return string
* @since 8.2.0 * @since 8.2.0
**/ */
public function detectPath($path); public function detectPath($path);
/**
* detect mimetype only based on the content of file
* @param string $path
* @return string
* @since 18.0.0
*/
public function detectContent(string $path): string;
/** /**
* detect mimetype based on both filename and content * detect mimetype based on both filename and content
* *

View File

@ -36,9 +36,10 @@ interface ICheck {
/** /**
* @param IStorage $storage * @param IStorage $storage
* @param string $path * @param string $path
* @param bool $isDir
* @since 9.1 * @since 9.1
*/ */
public function setFileInfo(IStorage $storage, $path); public function setFileInfo(IStorage $storage, $path, $isDir = false);
/** /**
* @param string $operator * @param string $operator

View File

@ -37,61 +37,96 @@ class DetectionTest extends \Test\TestCase {
); );
} }
public function testDetect() { public function dataDetectPath(): array {
$dir = \OC::$SERVERROOT.'/tests/data'; return [
['foo.txt', 'text/plain'],
$result = $this->detection->detect($dir."/"); ['foo.png', 'image/png'],
$expected = 'httpd/unix-directory'; ['foo.bar.png', 'image/png'],
$this->assertEquals($expected, $result); ['.hidden.png', 'image/png'],
['.hidden.foo.png', 'image/png'],
$result = $this->detection->detect($dir."/data.tar.gz"); ['.hidden/foo.png', 'image/png'],
$expected = 'application/x-gzip'; ['.hidden/.hidden.png', 'image/png'],
$this->assertEquals($expected, $result); ['test.jpg/foo.png', 'image/png'],
['.png', 'application/octet-stream'],
$result = $this->detection->detect($dir."/data.zip"); ['..hidden', 'application/octet-stream'],
$expected = 'application/zip'; ['foo', 'application/octet-stream'],
$this->assertEquals($expected, $result); ['', 'application/octet-stream'],
['foo.png.ocTransferId123456789.part', 'image/png'],
$result = $this->detection->detect($dir."/testimagelarge.svg"); ['foo.png.v1234567890', 'image/png'],
$expected = 'image/svg+xml'; ];
$this->assertEquals($expected, $result);
$result = $this->detection->detect($dir."/testimage.png");
$expected = 'image/png';
$this->assertEquals($expected, $result);
} }
public function testGetSecureMimeType() { /**
$result = $this->detection->getSecureMimeType('image/svg+xml'); * @dataProvider dataDetectPath
*
* @param string $path
* @param string $expected
*/
public function testDetectPath(string $path, string $expected): void {
$this->assertEquals($expected, $this->detection->detectPath($path));
}
public function dataDetectContent(): array {
return [
['/', 'httpd/unix-directory'],
['/data.tar.gz', 'application/x-gzip'],
['/data.zip', 'application/zip'],
['/testimage.mp3', 'audio/mpeg'],
['/testimage.png', 'image/png'],
];
}
/**
* @dataProvider dataDetectContent
*
* @param string $path
* @param string $expected
*/
public function testDetectContent(string $path, string $expected): void {
$this->assertEquals($expected, $this->detection->detectContent(\OC::$SERVERROOT . '/tests/data' . $path));
}
public function dataDetect(): array {
return [
['/', 'httpd/unix-directory'],
['/data.tar.gz', 'application/x-gzip'],
['/data.zip', 'application/zip'],
['/testimagelarge.svg', 'image/svg+xml'],
['/testimage.png', 'image/png'],
];
}
/**
* @dataProvider dataDetect
*
* @param string $path
* @param string $expected
*/
public function testDetect(string $path, string $expected): void {
$this->assertEquals($expected, $this->detection->detect(\OC::$SERVERROOT . '/tests/data' . $path));
}
public function testDetectString(): void {
$result = $this->detection->detectString('/data/data.tar.gz');
$expected = 'text/plain'; $expected = 'text/plain';
$this->assertEquals($expected, $result); $this->assertEquals($expected, $result);
$result = $this->detection->getSecureMimeType('image/png');
$expected = 'image/png';
$this->assertEquals($expected, $result);
} }
public function testDetectPath() { public function dataGetSecureMimeType(): array {
$this->assertEquals('text/plain', $this->detection->detectPath('foo.txt')); return [
$this->assertEquals('image/png', $this->detection->detectPath('foo.png')); ['image/svg+xml', 'text/plain'],
$this->assertEquals('image/png', $this->detection->detectPath('foo.bar.png')); ['image/png', 'image/png'],
$this->assertEquals('image/png', $this->detection->detectPath('.hidden.png')); ];
$this->assertEquals('image/png', $this->detection->detectPath('.hidden.foo.png'));
$this->assertEquals('image/png', $this->detection->detectPath('.hidden/foo.png'));
$this->assertEquals('image/png', $this->detection->detectPath('.hidden/.hidden.png'));
$this->assertEquals('image/png', $this->detection->detectPath('test.jpg/foo.png'));
$this->assertEquals('application/octet-stream', $this->detection->detectPath('.png'));
$this->assertEquals('application/octet-stream', $this->detection->detectPath('..hidden'));
$this->assertEquals('application/octet-stream', $this->detection->detectPath('foo'));
$this->assertEquals('application/octet-stream', $this->detection->detectPath(''));
$this->assertEquals('image/png', $this->detection->detectPath('foo.png.ocTransferId123456789.part'));
$this->assertEquals('image/png', $this->detection->detectPath('foo.png.v1234567890'));
} }
public function testDetectString() { /**
$result = $this->detection->detectString("/data/data.tar.gz"); * @dataProvider dataGetSecureMimeType
$expected = 'text/plain'; *
$this->assertEquals($expected, $result); * @param string $mimeType
* @param string $expected
*/
public function testGetSecureMimeType(string $mimeType, string $expected): void {
$this->assertEquals($expected, $this->detection->getSecureMimeType($mimeType));
} }
public function testMimeTypeIcon() { public function testMimeTypeIcon() {