Merge pull request #18236 from nextcloud/bugfix/noid/always-detect-mimetype-by-content-in-workflows

Allow to detect mimetype by content
This commit is contained in:
Roeland Jago Douma 2019-12-12 11:19:55 +01:00 committed by GitHub
commit c6e51924c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 232 additions and 213 deletions

View File

@ -57,12 +57,18 @@ class FileMimeType extends AbstractStringCheck implements IFileCheck {
/**
* @param IStorage $storage
* @param string $path
* @param bool $isDir
*/
public function setFileInfo(IStorage $storage, string $path) {
$this->_setFileInfo($storage, $path);
public function setFileInfo(IStorage $storage, string $path, bool $isDir = false): void {
$this->_setFileInfo($storage, $path, $isDir);
if (!isset($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;
}
}
}
@ -101,93 +107,24 @@ class FileMimeType extends AbstractStringCheck implements IFileCheck {
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
if ($this->request->getMethod() === 'MKCOL') {
return $this->cacheAndReturnMimeType($this->storage->getId(), $this->path, '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);
return 'httpd/unix-directory';
}
}
if (in_array($this->request->getMethod(), ['POST', 'PUT'])) {
$files = $this->request->getUploadedFile('files');
if (isset($files['type'][0])) {
$mimeType = $files['type'][0];
if ($mimeType === 'application/octet-stream') {
// 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';
}
// We do not cache this, as the file did not exist yet.
// In case it does in the future, we will check with detectContent()
// again to get the real mimetype of the content, rather than
// guessing it from the path.
return $this->mimeTypeDetector->detectPath($this->path);
}
/**

View File

@ -37,14 +37,19 @@ trait TFileCheck {
/** @var string */
protected $path;
/** @var bool */
protected $isDir;
/**
* @param IStorage $storage
* @param string $path
* @param bool $isDir
* @since 18.0.0
*/
public function setFileInfo(IStorage $storage, string $path) {
public function setFileInfo(IStorage $storage, string $path, bool $isDir = false): void {
$this->storage = $storage;
$this->path = $path;
$this->isDir = $isDir;
}
/**

View File

@ -71,9 +71,10 @@ class RuleMatcher implements IRuleMatcher {
$this->l = $l;
}
public function setFileInfo(IStorage $storage, string $path): void {
public function setFileInfo(IStorage $storage, string $path, bool $isDir = false): void {
$this->fileInfo['storage'] = $storage;
$this->fileInfo['path'] = $path;
$this->fileInfo['isDir'] = $isDir;
}
public function setEntitySubject(IEntity $entity, $subject): void {
@ -168,7 +169,7 @@ class RuleMatcher implements IRuleMatcher {
if (empty($this->fileInfo)) {
throw new RuntimeException('Must set file info before running the check');
}
$checkInstance->setFileInfo($this->fileInfo['storage'], $this->fileInfo['path']);
$checkInstance->setFileInfo($this->fileInfo['storage'], $this->fileInfo['path'], $this->fileInfo['isDir']);
} elseif ($checkInstance instanceof IEntityCheck) {
foreach($this->contexts as $entityInfo) {
list($entity, $subject) = $entityInfo;

View File

@ -1,4 +1,5 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
@ -77,8 +78,8 @@ class Detection implements IMimeTypeDetector {
*/
public function __construct(IURLGenerator $urlGenerator,
ILogger $logger,
$customConfigDir,
$defaultConfigDir) {
string $customConfigDir,
string $defaultConfigDir) {
$this->urlGenerator = $urlGenerator;
$this->logger = $logger;
$this->customConfigDir = $customConfigDir;
@ -96,9 +97,9 @@ class Detection implements IMimeTypeDetector {
* @param string $mimetype
* @param string|null $secureMimeType
*/
public function registerType($extension,
$mimetype,
$secureMimeType = null) {
public function registerType(string $extension,
string $mimetype,
?string $secureMimeType = null): void {
$this->mimetypes[$extension] = array($mimetype, $secureMimeType);
$this->secureMimeTypes[$mimetype] = $secureMimeType ?: $mimetype;
}
@ -112,12 +113,12 @@ class Detection implements IMimeTypeDetector {
*
* @param array $types
*/
public function registerTypeArray($types) {
public function registerTypeArray(array $types): void {
$this->mimetypes = array_merge($this->mimetypes, $types);
// Update the alternative mimetypes to avoid having to look them up each time.
foreach ($this->mimetypes as $mimeType) {
$this->secureMimeTypes[$mimeType[0]] = isset($mimeType[1]) ? $mimeType[1]: $mimeType[0];
$this->secureMimeTypes[$mimeType[0]] = $mimeType[1] ?? $mimeType[0];
}
}
@ -136,7 +137,7 @@ class Detection implements IMimeTypeDetector {
/**
* Add the mimetype aliases if they are not yet present
*/
private function loadAliases() {
private function loadAliases(): void {
if (!empty($this->mimeTypeAlias)) {
return;
}
@ -148,12 +149,12 @@ class Detection implements IMimeTypeDetector {
/**
* @return string[]
*/
public function getAllAliases() {
public function getAllAliases(): array {
$this->loadAliases();
return $this->mimeTypeAlias;
}
public function getOnlyDefaultAliases() {
public function getOnlyDefaultAliases(): array {
$this->loadMappings();
$this->mimeTypeAlias = json_decode(file_get_contents($this->defaultConfigDir . '/mimetypealiases.dist.json'), true);
return $this->mimeTypeAlias;
@ -162,7 +163,7 @@ class Detection implements IMimeTypeDetector {
/**
* Add mimetype mappings if they are not yet present
*/
private function loadMappings() {
private function loadMappings(): void {
if (!empty($this->mimetypes)) {
return;
}
@ -176,7 +177,7 @@ class Detection implements IMimeTypeDetector {
/**
* @return array
*/
public function getAllMappings() {
public function getAllMappings(): array {
$this->loadMappings();
return $this->mimetypes;
}
@ -187,7 +188,7 @@ class Detection implements IMimeTypeDetector {
* @param string $path
* @return string
*/
public function detectPath($path) {
public function detectPath($path): string {
$this->loadMappings();
$fileName = basename($path);
@ -199,17 +200,84 @@ class Detection implements IMimeTypeDetector {
if (strpos($fileName, '.') > 0) {
// 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
$extension = strtolower(strrchr($fileName, '.'));
$extension = substr($extension, 1); //remove leading .
return (isset($this->mimetypes[$extension]) && isset($this->mimetypes[$extension][0]))
? $this->mimetypes[$extension][0]
: 'application/octet-stream';
} else {
$extension = strrchr($fileName, '.');
if ($extension !== false) {
$extension = strtolower($extension);
$extension = substr($extension, 1); //remove leading .
return $this->mimetypes[$extension][0] ?? 'application/octet-stream';
}
}
return 'application/octet-stream';
}
/**
* detect mimetype only based on the content of file
* @param string $path
* @return string
* @since 18.0.0
*/
public function detectContent(string $path): string {
$this->loadMappings();
if (@is_dir($path)) {
// directories are easy
return 'httpd/unix-directory';
}
if (function_exists('finfo_open')
&& function_exists('finfo_file')
&& $finfo = finfo_open(FILEINFO_MIME)) {
$info = @finfo_file($finfo, $path);
finfo_close($finfo);
if ($info) {
$info = strtolower($info);
$mimeType = strpos($info, ';') !== false ? substr($info, 0, strpos($info, ';')) : $info;
$mimeType = $this->getSecureMimeType($mimeType);
if ($mimeType !== 'application/octet-stream') {
return $mimeType;
}
}
}
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
$mimeType = mime_content_type($path);
if ($mimeType !== false) {
$mimeType = $this->getSecureMimeType($mimeType);
if ($mimeType !== 'application/octet-stream') {
return $mimeType;
}
}
}
if (\OC_Helper::canExecute('file')) {
// it looks like we have a 'file' command,
// lets see if it does have mime support
$path = escapeshellarg($path);
$fp = popen("test -f $path && file -b --mime-type $path", 'r');
$mimeType = fgets($fp);
pclose($fp);
if ($mimeType !== false) {
//trim the newline
$mimeType = trim($mimeType);
$mimeType = $this->getSecureMimeType($mimeType);
if ($mimeType !== 'application/octet-stream') {
return $mimeType;
}
}
}
return 'application/octet-stream';
}
/**
@ -218,49 +286,14 @@ class Detection implements IMimeTypeDetector {
* @param string $path
* @return string
*/
public function detect($path) {
$this->loadMappings();
if (@is_dir($path)) {
// directories are easy
return "httpd/unix-directory";
}
public function detect($path): string {
$mimeType = $this->detectPath($path);
if ($mimeType === 'application/octet-stream' and function_exists('finfo_open')
and function_exists('finfo_file') and $finfo = finfo_open(FILEINFO_MIME)
) {
$info = @strtolower(finfo_file($finfo, $path));
finfo_close($finfo);
if ($info) {
$mimeType = strpos($info, ';') !== false ? substr($info, 0, strpos($info, ';')) : $info;
return empty($mimeType) ? 'application/octet-stream' : $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")) {
// use mime magic extension if available
$mimeType = mime_content_type($path);
}
if (!$isWrapped and $mimeType === 'application/octet-stream' && \OC_Helper::canExecute("file")) {
// it looks like we have a 'file' command,
// lets see if it does have mime support
$path = escapeshellarg($path);
$fp = popen("file -b --mime-type $path 2>/dev/null", "r");
$reply = fgets($fp);
pclose($fp);
//trim the newline
$mimeType = trim($reply);
if (empty($mimeType)) {
$mimeType = 'application/octet-stream';
}
}
return $mimeType;
return $this->detectContent($path);
}
/**
@ -269,20 +302,20 @@ class Detection implements IMimeTypeDetector {
* @param string $data
* @return string
*/
public function detectString($data) {
if (function_exists('finfo_open') and function_exists('finfo_file')) {
public function detectString($data): string {
if (function_exists('finfo_open') && function_exists('finfo_file')) {
$finfo = finfo_open(FILEINFO_MIME);
$info = finfo_buffer($finfo, $data);
return strpos($info, ';') !== false ? substr($info, 0, strpos($info, ';')) : $info;
} else {
$tmpFile = \OC::$server->getTempManager()->getTemporaryFile();
$fh = fopen($tmpFile, 'wb');
fwrite($fh, $data, 8024);
fclose($fh);
$mime = $this->detect($tmpFile);
unset($tmpFile);
return $mime;
}
$tmpFile = \OC::$server->getTempManager()->getTemporaryFile();
$fh = fopen($tmpFile, 'wb');
fwrite($fh, $data, 8024);
fclose($fh);
$mime = $this->detect($tmpFile);
unset($tmpFile);
return $mime;
}
/**
@ -291,12 +324,10 @@ class Detection implements IMimeTypeDetector {
* @param string $mimeType
* @return string
*/
public function getSecureMimeType($mimeType) {
public function getSecureMimeType($mimeType): string {
$this->loadMappings();
return isset($this->secureMimeTypes[$mimeType])
? $this->secureMimeTypes[$mimeType]
: 'application/octet-stream';
return $this->secureMimeTypes[$mimeType] ?? 'application/octet-stream';
}
/**
@ -304,7 +335,7 @@ class Detection implements IMimeTypeDetector {
* @param string $mimetype the MIME type
* @return string the url
*/
public function mimeTypeIcon($mimetype) {
public function mimeTypeIcon($mimetype): string {
$this->loadAliases();
while (isset($this->mimeTypeAlias[$mimetype])) {
@ -315,8 +346,7 @@ class Detection implements IMimeTypeDetector {
}
// Replace slash and backslash with a minus
$icon = str_replace('/', '-', $mimetype);
$icon = str_replace('\\', '-', $icon);
$icon = str_replace(['/', '\\'], '-', $mimetype);
// Is it a dir?
if ($mimetype === 'dir') {

View File

@ -40,9 +40,17 @@ interface IMimeTypeDetector {
* @param string $path
* @return string
* @since 8.2.0
**/
*/
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
*

View File

@ -37,8 +37,11 @@ use OCP\Files\Storage\IStorage;
*/
interface IFileCheck extends IEntityCheck {
/**
* @param IStorage $storage
* @param string $path
* @param bool $isDir
* @since 18.0.0
*/
public function setFileInfo(IStorage $storage, string $path);
public function setFileInfo(IStorage $storage, string $path, bool $isDir = false): void;
}

View File

@ -39,61 +39,96 @@ class DetectionTest extends \Test\TestCase {
);
}
public function testDetect() {
$dir = \OC::$SERVERROOT.'/tests/data';
$result = $this->detection->detect($dir."/");
$expected = 'httpd/unix-directory';
$this->assertEquals($expected, $result);
$result = $this->detection->detect($dir."/data.tar.gz");
$expected = 'application/x-gzip';
$this->assertEquals($expected, $result);
$result = $this->detection->detect($dir."/data.zip");
$expected = 'application/zip';
$this->assertEquals($expected, $result);
$result = $this->detection->detect($dir."/testimagelarge.svg");
$expected = 'image/svg+xml';
$this->assertEquals($expected, $result);
$result = $this->detection->detect($dir."/testimage.png");
$expected = 'image/png';
$this->assertEquals($expected, $result);
public function dataDetectPath(): array {
return [
['foo.txt', 'text/plain'],
['foo.png', 'image/png'],
['foo.bar.png', 'image/png'],
['.hidden.png', 'image/png'],
['.hidden.foo.png', 'image/png'],
['.hidden/foo.png', 'image/png'],
['.hidden/.hidden.png', 'image/png'],
['test.jpg/foo.png', 'image/png'],
['.png', 'application/octet-stream'],
['..hidden', 'application/octet-stream'],
['foo', 'application/octet-stream'],
['', 'application/octet-stream'],
['foo.png.ocTransferId123456789.part', 'image/png'],
['foo.png.v1234567890', 'image/png'],
];
}
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'], TODO: fix as it fails hard on php7.4 now
['/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';
$this->assertEquals($expected, $result);
$result = $this->detection->getSecureMimeType('image/png');
$expected = 'image/png';
$this->assertEquals($expected, $result);
}
public function testDetectPath() {
$this->assertEquals('text/plain', $this->detection->detectPath('foo.txt'));
$this->assertEquals('image/png', $this->detection->detectPath('foo.png'));
$this->assertEquals('image/png', $this->detection->detectPath('foo.bar.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 dataGetSecureMimeType(): array {
return [
['image/svg+xml', 'text/plain'],
['image/png', 'image/png'],
];
}
public function testDetectString() {
$result = $this->detection->detectString("/data/data.tar.gz");
$expected = 'text/plain';
$this->assertEquals($expected, $result);
/**
* @dataProvider dataGetSecureMimeType
*
* @param string $mimeType
* @param string $expected
*/
public function testGetSecureMimeType(string $mimeType, string $expected): void {
$this->assertEquals($expected, $this->detection->getSecureMimeType($mimeType));
}
public function testMimeTypeIcon() {