summaryrefslogtreecommitdiffstats
path: root/lib/public/Share
diff options
context:
space:
mode:
authorLouis Chemineau <louis@chmn.me>2023-01-18 16:53:22 +0100
committerLouis Chemineau <louis@chmn.me>2023-02-02 15:41:26 +0100
commit4ab3c16403e69811cf2353ba2bfeafcbcf259c42 (patch)
tree981b24806dfde120a7170957cac022b3bfdb74b9 /lib/public/Share
parentfc4e87a2dfc5ff53bc9f15da13f355dd285769a9 (diff)
downloadnextcloud-server-4ab3c16403e69811cf2353ba2bfeafcbcf259c42.tar.gz
nextcloud-server-4ab3c16403e69811cf2353ba2bfeafcbcf259c42.zip
Pluggable share provider
Signed-off-by: Carl Schwan <carl@carlschwan.eu> Signed-off-by: Louis Chemineau <louis@chmn.me>
Diffstat (limited to 'lib/public/Share')
-rw-r--r--lib/public/Share/IPublicShareTemplateFactory.php35
-rw-r--r--lib/public/Share/IPublicShareTemplateProvider.php42
2 files changed, 77 insertions, 0 deletions
diff --git a/lib/public/Share/IPublicShareTemplateFactory.php b/lib/public/Share/IPublicShareTemplateFactory.php
new file mode 100644
index 00000000000..248473c145d
--- /dev/null
+++ b/lib/public/Share/IPublicShareTemplateFactory.php
@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2023 Louis Chemineau <louis@chmn.me>
+ *
+ * @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/>.
+ *
+ */
+
+namespace OCP\Share;
+
+/**
+ * @since 26.0.0
+ */
+interface IPublicShareTemplateFactory {
+ /**
+ * Returns a provider that is willing to respond for given share.
+ * @since 26.0.0
+ */
+ public function getProvider(IShare $share): IPublicShareTemplateProvider;
+}
diff --git a/lib/public/Share/IPublicShareTemplateProvider.php b/lib/public/Share/IPublicShareTemplateProvider.php
new file mode 100644
index 00000000000..5ef5adaed13
--- /dev/null
+++ b/lib/public/Share/IPublicShareTemplateProvider.php
@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2023 Louis Chemineau <louis@chmn.me>
+ *
+ * @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/>.
+ *
+ */
+
+namespace OCP\Share;
+
+use OCP\AppFramework\Http\TemplateResponse;
+
+/**
+ * @since 26.0.0
+ */
+interface IPublicShareTemplateProvider {
+ /**
+ * Returns whether the provider can respond for the given share.
+ * @since 26.0.0
+ */
+ public function shouldRespond(IShare $share): bool;
+ /**
+ * Returns the a template for a given share.
+ * @since 26.0.0
+ */
+ public function renderPage(IShare $share, string $token, string $path): TemplateResponse;
+}