aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Preview
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Preview')
-rw-r--r--lib/public/Preview/BeforePreviewFetchedEvent.php83
-rw-r--r--lib/public/Preview/IMimeIconProvider.php22
-rw-r--r--lib/public/Preview/IProvider.php25
-rw-r--r--lib/public/Preview/IProviderV2.php22
-rw-r--r--lib/public/Preview/IVersionedPreviewFile.php22
5 files changed, 113 insertions, 61 deletions
diff --git a/lib/public/Preview/BeforePreviewFetchedEvent.php b/lib/public/Preview/BeforePreviewFetchedEvent.php
new file mode 100644
index 00000000000..8ab875070d9
--- /dev/null
+++ b/lib/public/Preview/BeforePreviewFetchedEvent.php
@@ -0,0 +1,83 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Preview;
+
+use OCP\Files\Node;
+use OCP\IPreview;
+
+/**
+ * Emitted before a file preview is being fetched.
+ *
+ * It can be used to block preview rendering by throwing a ``OCP\Files\NotFoundException``
+ *
+ * @since 25.0.1
+ * @since 28.0.0 the constructor arguments ``$width``, ``$height``, ``$crop`` and ``$mode`` are no longer nullable.
+ * @since 31.0.0 the constructor arguments ``$mimeType`` was added
+ */
+class BeforePreviewFetchedEvent extends \OCP\EventDispatcher\Event {
+ /**
+ * @since 25.0.1
+ */
+ public function __construct(
+ private Node $node,
+ /** @deprecated 28.0.0 passing null is deprecated **/
+ private ?int $width = null,
+ /** @deprecated 28.0.0 passing null is deprecated **/
+ private ?int $height = null,
+ /** @deprecated 28.0.0 passing null is deprecated **/
+ private ?bool $crop = null,
+ /** @deprecated 28.0.0 passing null is deprecated **/
+ private ?string $mode = null,
+ private ?string $mimeType = null,
+ ) {
+ parent::__construct();
+ }
+
+ /**
+ * @since 25.0.1
+ */
+ public function getNode(): Node {
+ return $this->node;
+ }
+
+ /**
+ * @since 28.0.0
+ */
+ public function getWidth(): ?int {
+ return $this->width;
+ }
+
+ /**
+ * @since 28.0.0
+ */
+ public function getHeight(): ?int {
+ return $this->height;
+ }
+
+ /**
+ * @since 28.0.0
+ */
+ public function isCrop(): ?bool {
+ return $this->crop;
+ }
+
+ /**
+ * @since 28.0.0
+ * @return null|IPreview::MODE_FILL|IPreview::MODE_COVER
+ */
+ public function getMode(): ?string {
+ return $this->mode;
+ }
+
+ /**
+ * @since 31.0.0
+ */
+ public function getMimeType(): ?string {
+ return $this->mimeType;
+ }
+}
diff --git a/lib/public/Preview/IMimeIconProvider.php b/lib/public/Preview/IMimeIconProvider.php
new file mode 100644
index 00000000000..4a407f48577
--- /dev/null
+++ b/lib/public/Preview/IMimeIconProvider.php
@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Preview;
+
+/**
+ * Interface IMimeIconProvider
+ *
+ * @since 28.0.0
+ */
+interface IMimeIconProvider {
+ /**
+ * Get the URL to the icon for the given mime type
+ * Used by the preview provider to show a mime icon
+ * if no preview is available.
+ * @since 28.0.0
+ */
+ public function getMimeIconUrl(string $mime): ?string;
+}
diff --git a/lib/public/Preview/IProvider.php b/lib/public/Preview/IProvider.php
index 801aa276d83..b06acfbbe5d 100644
--- a/lib/public/Preview/IProvider.php
+++ b/lib/public/Preview/IProvider.php
@@ -1,26 +1,9 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Joas Schilling <coding@schilljs.com>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- *
- * @license AGPL-3.0
- *
- * 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/>
- *
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OCP\Preview;
diff --git a/lib/public/Preview/IProviderV2.php b/lib/public/Preview/IProviderV2.php
index 8b5f85b3d5c..da52f6a7946 100644
--- a/lib/public/Preview/IProviderV2.php
+++ b/lib/public/Preview/IProviderV2.php
@@ -1,27 +1,9 @@
<?php
declare(strict_types=1);
-
/**
- * @copyright Copyright (c) 2019 Robin Appelman <robin@icewind.nl>
- *
- * @author Robin Appelman <robin@icewind.nl>
- *
- * @license GNU AGPL version 3 or any later version
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * 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
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
+ * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\Preview;
diff --git a/lib/public/Preview/IVersionedPreviewFile.php b/lib/public/Preview/IVersionedPreviewFile.php
index e41e7db78cd..9266b1ac067 100644
--- a/lib/public/Preview/IVersionedPreviewFile.php
+++ b/lib/public/Preview/IVersionedPreviewFile.php
@@ -1,27 +1,9 @@
<?php
declare(strict_types=1);
-
/**
- * @copyright Copyright (c) 2019 Robin Appelman <robin@icewind.nl>
- *
- * @author Robin Appelman <robin@icewind.nl>
- *
- * @license GNU AGPL version 3 or any later version
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * 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
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
+ * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\Preview;