Skip to content

Commit

Permalink
feat: redirect to the mime icon if no preview available
Browse files Browse the repository at this point in the history
Signed-off-by: John Molakvoæ <skjnldsv@protonmail.com>
  • Loading branch information
skjnldsv committed Aug 11, 2023
1 parent db2a576 commit 3d7bfae
Show file tree
Hide file tree
Showing 9 changed files with 166 additions and 22 deletions.
17 changes: 2 additions & 15 deletions apps/files/src/components/FileEntry.vue
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,6 @@
class="files-list__row-icon-preview"
:style="{ backgroundImage }" />

<span v-else-if="mimeIconUrl"
class="files-list__row-icon-preview files-list__row-icon-preview--mime"
:style="{ backgroundImage: mimeIconUrl }" />

<FileIcon v-else />

<!-- Favorite icon -->
Expand Down Expand Up @@ -155,17 +151,16 @@
</template>

<script lang='ts'>
import { CancelablePromise } from 'cancelable-promise'
import { debounce } from 'debounce'
import { emit } from '@nextcloud/event-bus'
import { extname } from 'path'
import { formatFileSize, Permission } from '@nextcloud/files'
import { Fragment } from 'vue-frag'
import { generateUrl } from '@nextcloud/router'
import { showError, showSuccess } from '@nextcloud/dialogs'
import { translate } from '@nextcloud/l10n'
import { vOnClickOutside } from '@vueuse/components'
import axios from '@nextcloud/axios'
import CancelablePromise from 'cancelable-promise'
import FileIcon from 'vue-material-design-icons/File.vue'
import FolderIcon from 'vue-material-design-icons/Folder.vue'
import moment from '@nextcloud/moment'
Expand Down Expand Up @@ -205,7 +200,6 @@ export default Vue.extend({
FavoriteIcon,
FileIcon,
FolderIcon,
Fragment,
NcActionButton,
NcActions,
NcCheckboxRadioSwitch,
Expand Down Expand Up @@ -394,6 +388,7 @@ export default Vue.extend({
// Request tiny previews
url.searchParams.set('x', '32')
url.searchParams.set('y', '32')
url.searchParams.set('mimeFallback', 'true')

// Handle cropping
url.searchParams.set('a', this.cropPreviews === true ? '0' : '1')
Expand All @@ -402,14 +397,6 @@ export default Vue.extend({
return null
}
},
mimeIconUrl() {
const mimeType = this.source.mime || 'application/octet-stream'
const mimeIconUrl = window.OC?.MimeType?.getIconUrl?.(mimeType)
if (mimeIconUrl) {
return `url(${mimeIconUrl})`
}
return ''
},

// Sorted actions that are enabled for this node
enabledActions() {
Expand Down
2 changes: 1 addition & 1 deletion apps/files/src/components/VirtualList.vue
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<tbody :style="tbodyStyle" class="files-list__tbody">
<component :is="dataComponent"
v-for="(item, i) in renderedItems"
:key="item[dataKey]"
:key="i"
:active="(i >= bufferItems || index <= bufferItems) && (i < shownItems - bufferItems)"
:source="item"
:index="i"
Expand Down
27 changes: 21 additions & 6 deletions core/Controller/PreviewController.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,14 @@
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\Http\FileDisplayResponse;
use OCP\AppFramework\Http\RedirectResponse;
use OCP\Files\File;
use OCP\Files\IRootFolder;
use OCP\Files\Node;
use OCP\Files\NotFoundException;
use OCP\IPreview;
use OCP\IRequest;
use OCP\Preview\IMimeIconProvider;

class PreviewController extends Controller {
public function __construct(
Expand All @@ -46,6 +48,7 @@ public function __construct(
private IPreview $preview,
private IRootFolder $root,
private ?string $userId,
private IMimeIconProvider $mimeIconProvider,
) {
parent::__construct($appName, $request);
}
Expand All @@ -62,6 +65,7 @@ public function __construct(
* @param bool $a Whether to not crop the preview
* @param bool $forceIcon Force returning an icon
* @param string $mode How to crop the image
* @param bool $mimeFallback Whether to fallback to the mime icon if no preview is available
* @return FileDisplayResponse<Http::STATUS_OK, array{Content-Type: string}>|DataResponse<Http::STATUS_BAD_REQUEST|Http::STATUS_FORBIDDEN|Http::STATUS_NOT_FOUND, array<empty>, array{}>
*
* 200: Preview returned
Expand All @@ -75,7 +79,8 @@ public function getPreview(
int $y = 32,
bool $a = false,
bool $forceIcon = true,
string $mode = 'fill'): Http\Response {
string $mode = 'fill',
bool $mimeFallback): Http\Response {
if ($file === '' || $x === 0 || $y === 0) {
return new DataResponse([], Http::STATUS_BAD_REQUEST);
}
Expand All @@ -87,7 +92,7 @@ public function getPreview(
return new DataResponse([], Http::STATUS_NOT_FOUND);
}

return $this->fetchPreview($node, $x, $y, $a, $forceIcon, $mode);
return $this->fetchPreview($node, $x, $y, $a, $forceIcon, $mode, $mimeFallback);
}

/**
Expand All @@ -102,6 +107,7 @@ public function getPreview(
* @param bool $a Whether to not crop the preview
* @param bool $forceIcon Force returning an icon
* @param string $mode How to crop the image
* @param bool $mimeFallback Whether to fallback to the mime icon if no preview is available
* @return FileDisplayResponse<Http::STATUS_OK, array{Content-Type: string}>|DataResponse<Http::STATUS_BAD_REQUEST|Http::STATUS_FORBIDDEN|Http::STATUS_NOT_FOUND, array<empty>, array{}>
*
* 200: Preview returned
Expand All @@ -115,7 +121,8 @@ public function getPreviewByFileId(
int $y = 32,
bool $a = false,
bool $forceIcon = true,
string $mode = 'fill') {
string $mode = 'fill',
bool $mimeFallback = false) {
if ($fileId === -1 || $x === 0 || $y === 0) {
return new DataResponse([], Http::STATUS_BAD_REQUEST);
}
Expand All @@ -129,19 +136,20 @@ public function getPreviewByFileId(

$node = array_pop($nodes);

return $this->fetchPreview($node, $x, $y, $a, $forceIcon, $mode);
return $this->fetchPreview($node, $x, $y, $a, $forceIcon, $mode, $mimeFallback);
}

/**
* @return FileDisplayResponse<Http::STATUS_OK, array{Content-Type: string}>|DataResponse<Http::STATUS_BAD_REQUEST|Http::STATUS_FORBIDDEN|Http::STATUS_NOT_FOUND, array<empty>, array{}>
* @return FileDisplayResponse<Http::STATUS_OK, array{Content-Type: string}>|DataResponse<Http::STATUS_BAD_REQUEST|Http::STATUS_FORBIDDEN|Http::STATUS_NOT_FOUND, array<empty>, array{}>|RedirectResponse<string>
*/
private function fetchPreview(
Node $node,
int $x,
int $y,
bool $a,
bool $forceIcon,
string $mode) : Http\Response {
string $mode,
bool $mimeFallback = false) : Http\Response {
if (!($node instanceof File) || (!$forceIcon && !$this->preview->isAvailable($node))) {
return new DataResponse([], Http::STATUS_NOT_FOUND);
}
Expand All @@ -167,6 +175,13 @@ private function fetchPreview(
$response->cacheFor(3600 * 24, false, true);
return $response;
} catch (NotFoundException $e) {
// If we have no preview enabled, we can redirect to the mime icon if any
if ($mimeFallback) {
if ($url = $this->mimeIconProvider->getMimeIconUrl($node->getMimeType())) {
return new RedirectResponse($url);
}
}

return new DataResponse([], Http::STATUS_NOT_FOUND);
} catch (\InvalidArgumentException $e) {
return new DataResponse([], Http::STATUS_BAD_REQUEST);
Expand Down
2 changes: 2 additions & 0 deletions lib/composer/composer/autoload_classmap.php
Original file line number Diff line number Diff line change
Expand Up @@ -533,6 +533,7 @@
'OCP\\OCS\\IDiscoveryService' => $baseDir . '/lib/public/OCS/IDiscoveryService.php',
'OCP\\PreConditionNotMetException' => $baseDir . '/lib/public/PreConditionNotMetException.php',
'OCP\\Preview\\BeforePreviewFetchedEvent' => $baseDir . '/lib/public/Preview/BeforePreviewFetchedEvent.php',
'OCP\\Preview\\IMimeIconProvider' => $baseDir . '/lib/public/Preview/IMimeIconProvider.php',
'OCP\\Preview\\IProvider' => $baseDir . '/lib/public/Preview/IProvider.php',
'OCP\\Preview\\IProviderV2' => $baseDir . '/lib/public/Preview/IProviderV2.php',
'OCP\\Preview\\IVersionedPreviewFile' => $baseDir . '/lib/public/Preview/IVersionedPreviewFile.php',
Expand Down Expand Up @@ -1479,6 +1480,7 @@
'OC\\Preview\\MSOffice2007' => $baseDir . '/lib/private/Preview/MSOffice2007.php',
'OC\\Preview\\MSOfficeDoc' => $baseDir . '/lib/private/Preview/MSOfficeDoc.php',
'OC\\Preview\\MarkDown' => $baseDir . '/lib/private/Preview/MarkDown.php',
'OC\\Preview\\MimeIconProvider' => $baseDir . '/lib/private/Preview/MimeIconProvider.php',
'OC\\Preview\\Movie' => $baseDir . '/lib/private/Preview/Movie.php',
'OC\\Preview\\Office' => $baseDir . '/lib/private/Preview/Office.php',
'OC\\Preview\\OpenDocument' => $baseDir . '/lib/private/Preview/OpenDocument.php',
Expand Down
2 changes: 2 additions & 0 deletions lib/composer/composer/autoload_static.php
Original file line number Diff line number Diff line change
Expand Up @@ -566,6 +566,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
'OCP\\OCS\\IDiscoveryService' => __DIR__ . '/../../..' . '/lib/public/OCS/IDiscoveryService.php',
'OCP\\PreConditionNotMetException' => __DIR__ . '/../../..' . '/lib/public/PreConditionNotMetException.php',
'OCP\\Preview\\BeforePreviewFetchedEvent' => __DIR__ . '/../../..' . '/lib/public/Preview/BeforePreviewFetchedEvent.php',
'OCP\\Preview\\IMimeIconProvider' => __DIR__ . '/../../..' . '/lib/public/Preview/IMimeIconProvider.php',
'OCP\\Preview\\IProvider' => __DIR__ . '/../../..' . '/lib/public/Preview/IProvider.php',
'OCP\\Preview\\IProviderV2' => __DIR__ . '/../../..' . '/lib/public/Preview/IProviderV2.php',
'OCP\\Preview\\IVersionedPreviewFile' => __DIR__ . '/../../..' . '/lib/public/Preview/IVersionedPreviewFile.php',
Expand Down Expand Up @@ -1512,6 +1513,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
'OC\\Preview\\MSOffice2007' => __DIR__ . '/../../..' . '/lib/private/Preview/MSOffice2007.php',
'OC\\Preview\\MSOfficeDoc' => __DIR__ . '/../../..' . '/lib/private/Preview/MSOfficeDoc.php',
'OC\\Preview\\MarkDown' => __DIR__ . '/../../..' . '/lib/private/Preview/MarkDown.php',
'OC\\Preview\\MimeIconProvider' => __DIR__ . '/../../..' . '/lib/private/Preview/MimeIconProvider.php',
'OC\\Preview\\Movie' => __DIR__ . '/../../..' . '/lib/private/Preview/Movie.php',
'OC\\Preview\\Office' => __DIR__ . '/../../..' . '/lib/private/Preview/Office.php',
'OC\\Preview\\OpenDocument' => __DIR__ . '/../../..' . '/lib/private/Preview/OpenDocument.php',
Expand Down
98 changes: 98 additions & 0 deletions lib/private/Preview/MimeIconProvider.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
<?php
/**
* @copyright Copyright (c) 2023 John Molakvoæ <skjnldsv@protonmail.com>
*
* @author John Molakvoæ <skjnldsv@protonmail.com>
*
* @license AGPL-3.0-or-later
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OC\Preview;

use OCA\Theming\ThemingDefaults;
use OCP\App\IAppManager;
use OCP\Files\IMimeTypeDetector;
use OCP\IConfig;
use OCP\IURLGenerator;
use OCP\Preview\IMimeIconProvider;

class MimeIconProvider implements IMimeIconProvider {

public function __construct(
protected IMimeTypeDetector $mimetypeDetector,
protected IConfig $config,
protected IURLGenerator $urlGenerator,
protected IAppManager $appManager,
protected ThemingDefaults $themingDefaults,
) {}

public function getMimeIconUrl(string $mime): string|null {
if (!$mime) {
return null;
}

// Fetch all the aliases
$aliases = $this->mimetypeDetector->getAllAliases();

// Remove comments
$aliases = array_filter($aliases, static function ($key) {
return !($key === '' || $key[0] === '_');
}, ARRAY_FILTER_USE_KEY);

// Map all the aliases recursively
foreach ($aliases as $alias => $value) {
if ($alias === $mime) {
$mime = $value;
}
}

$fileName = str_replace('/', '-', $mime);
if ($url = $this->searchfileName($fileName)) {
return $url;
}

$mimeType = explode('/', $mime)[0];
if ($url = $this->searchfileName($mimeType)) {
return $url;
}

return null;
}

private function searchfileName(string $fileName): string|null {
// If the file exists in the current enabled legacy
// custom theme, let's return it
$theme = $this->config->getSystemValue('theme', '');
if (!empty($theme)) {
$path = "/themes/$theme/core/img/filetypes/$fileName.svg";
if (file_exists(\OC::$SERVERROOT . $path)) {
return $this->urlGenerator->getAbsoluteURL($path);
}
}

// Previously, we used to pass thi through Theming
// But it was only used to colour icons containing
// 0082c9. Since with vue we moved to inline svg icons,
// we can just use the default core icons.

// Finally, if the file exists in core, let's return it
$path = "/core/img/filetypes/$fileName.svg";
if (file_exists(\OC::$SERVERROOT . $path)) {
return $this->urlGenerator->getAbsoluteURL($path);
}

return null;
}
}
3 changes: 3 additions & 0 deletions lib/private/Server.php
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@
use OC\OCS\DiscoveryService;
use OC\Preview\GeneratorHelper;
use OC\Preview\IMagickSupport;
use OC\Preview\MimeIconProvider;
use OC\Remote\Api\ApiFactory;
use OC\Remote\InstanceFactory;
use OC\RichObjectStrings\Validator;
Expand Down Expand Up @@ -262,6 +263,7 @@
use OCA\Files_External\Service\BackendService;
use OCP\Profiler\IProfiler;
use OC\Profiler\Profiler;
use OCP\Preview\IMimeIconProvider;

/**
* Class Server
Expand Down Expand Up @@ -337,6 +339,7 @@ public function __construct($webRoot, \OC\Config $config) {
});
/** @deprecated 19.0.0 */
$this->registerDeprecatedAlias('PreviewManager', IPreview::class);
$this->registerAlias(IMimeIconProvider::class, MimeIconProvider::class);

$this->registerService(\OC\Preview\Watcher::class, function (ContainerInterface $c) {
return new \OC\Preview\Watcher(
Expand Down
6 changes: 6 additions & 0 deletions lib/public/Files/IMimeTypeDetector.php
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,10 @@ public function detectString($data);
* @since 8.2.0
*/
public function mimeTypeIcon($mimeType);

/**
* @return string[]
* @since 28.0.0
*/
public function getAllAliases(): array;
}
31 changes: 31 additions & 0 deletions lib/public/Preview/IMimeIconProvider.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?php
/**
* @copyright Copyright (c) 2023 John Molakvoæ <skjnldsv@protonmail.com>
*
* @author John Molakvoæ <skjnldsv@protonmail.com>
*
* @license AGPL-3.0-or-later
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OCP\Preview;

/**
* Interface IMimeIconProvider
*
* @since 28.0.0
*/
interface IMimeIconProvider {
public function getMimeIconUrl(string $mime): string|null;
}

0 comments on commit 3d7bfae

Please sign in to comment.