Use FileCreatedFromTemplateEvent to inject the already existing empty…

… template files for Collabora Signed-off-by: Julius Härtl <[email protected]> Cleanup template loading Signed-off-by: Julius Härtl <[email protected]> Fix template handling Signed-off-by: Julius Härtl <[email protected]>
nextcloud · Dec 20, 2021 · 1c87f3d · 1c87f3d
1 parent ea882d3
commit 1c87f3d
Show file tree

Hide file tree

Showing 13 changed files with 299 additions and 44 deletions.
diff --git a/appinfo/info.xml b/appinfo/info.xml
@@ -6,7 +6,7 @@
 	<description><![CDATA[This application can connect to a Collabora Online (or other) server (WOPI-like Client). Nextcloud is the WOPI Host. Please read the documentation to learn more about that.
 
 You can also edit your documents off-line with the Collabora Office app from the **[Android](https://play.google.com/store/apps/details?id=com.collabora.libreoffice)** and **[iOS](https://apps.apple.com/us/app/collabora-office/id1440482071)** store.]]></description>
-	<version>5.0.0-beta1</version>
+	<version>6.0.0-dev.1</version>
 	<licence>agpl</licence>
 	<author>Collabora Productivity based on work of Frank Karlitschek, Victor Dubiniuk</author>
 	<types>
@@ -31,6 +31,7 @@ You can also edit your documents off-line with the Collabora Office app from the
 	</dependencies>
 	<background-jobs>
 		<job>OCA\Richdocuments\Backgroundjobs\ObtainCapabilities</job>
+		<job>OCA\Richdocuments\Backgroundjobs\Cleanup</job>
 	</background-jobs>
 	<commands>
 		<command>OCA\Richdocuments\Command\ActivateConfig</command>

diff --git a/emptyTemplates/odttemplate.odt b/emptyTemplates/odttemplate.odt
diff --git a/emptyTemplates/docxtemplate.docx → emptyTemplates/template.docx b/emptyTemplates/docxtemplate.docx → emptyTemplates/template.docx
diff --git a/emptyTemplates/odgtemplate.otg → emptyTemplates/template.odg b/emptyTemplates/odgtemplate.otg → emptyTemplates/template.odg
diff --git a/emptyTemplates/pptxtemplate.pptx → emptyTemplates/template.pptx b/emptyTemplates/pptxtemplate.pptx → emptyTemplates/template.pptx
diff --git a/emptyTemplates/xlsxtemplate.xlsx → emptyTemplates/template.xlsx b/emptyTemplates/xlsxtemplate.xlsx → emptyTemplates/template.xlsx
diff --git a/lib/AppInfo/Application.php b/lib/AppInfo/Application.php
@@ -31,6 +31,7 @@
 use OCA\Richdocuments\AppConfig;
 use OCA\Richdocuments\Capabilities;
 use OCA\Richdocuments\Middleware\WOPIMiddleware;
+use OCA\Richdocuments\Listener\FileCreatedFromTemplateListener;
 use OCA\Richdocuments\PermissionManager;
 use OCA\Richdocuments\Preview\MSExcel;
 use OCA\Richdocuments\Preview\MSWord;
@@ -48,6 +49,7 @@
 use OCP\AppFramework\Bootstrap\IBootstrap;
 use OCP\AppFramework\Bootstrap\IRegistrationContext;
 use OCP\EventDispatcher\IEventDispatcher;
+use OCP\Files\Template\FileCreatedFromTemplateEvent;
 use OCP\Files\Template\ITemplateManager;
 use OCP\Files\Template\TemplateFileCreator;
 use OCP\IConfig;
@@ -68,6 +70,7 @@ public function register(IRegistrationContext $context): void {
 		$context->registerTemplateProvider(CollaboraTemplateProvider::class);
 		$context->registerCapability(Capabilities::class);
 		$context->registerMiddleWare(WOPIMiddleware::class);
+		$context->registerEventListener(FileCreatedFromTemplateEvent::class, FileCreatedFromTemplateListener::class);
 	}
 
 	public function boot(IBootContext $context): void {

diff --git a/lib/Backgroundjobs/Cleanup.php b/lib/Backgroundjobs/Cleanup.php
@@ -0,0 +1,49 @@
+<?php
+/**
+ * @copyright Copyright (c) 2019, Roeland Jago Douma <[email protected]>
+ *
+ * @author Roeland Jago Douma <[email protected]>
+ *
+ * @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 OCA\Richdocuments\Backgroundjobs;
+
+use OC\BackgroundJob\TimedJob;
+use OCA\Richdocuments\Service\CapabilitiesService;
+use OCP\DB\QueryBuilder\IQueryBuilder;
+use OCP\IDBConnection;
+
+class Cleanup extends TimedJob {
+
+	/** @var IDBConnection */
+	private $db;
+
+	public function __construct(IDBConnection $db) {
+		$this->db = $db;
+
+		$this->setInterval(60*60);
+	}
+
+	protected function run($argument) {
+		// Expire template mappings for file creation
+		$query = $this->db->getQueryBuilder();
+		$query->delete('richdocuments_template')
+			->where($query->expr()->lte('timestamp', $query->createNamedParameter(time() - 60, IQueryBuilder::PARAM_INT)));
+		$query->executeStatement();
+	}
+}
diff --git a/lib/Controller/DocumentController.php b/lib/Controller/DocumentController.php
@@ -11,6 +11,7 @@
 
 namespace OCA\Richdocuments\Controller;
 
+use OCA\Richdocuments\AppInfo\Application;
 use OCA\Richdocuments\Events\BeforeFederationRedirectEvent;
 use OCA\Richdocuments\Service\FederationService;
 use OCA\Richdocuments\Service\InitialStateService;
@@ -210,7 +211,14 @@ public function index($fileId, $path = null) {
 				return $response;
 			}
 
-			list($urlSrc, $token, $wopi) = $this->tokenManager->getToken($item->getId());
+			$templateFile = $this->templateManager->getTemplateSource($item->getId());
+			if ($templateFile) {
+				list($urlSrc, $wopi) = $this->tokenManager->getTokenForTemplate($templateFile, $this->uid, $item->getId());
+				$token = $wopi->getToken();
+			} else {
+				list($urlSrc, $token, $wopi) = $this->tokenManager->getToken($item->getId());
+			}
+
 			$params = [
 				'permissions' => $item->getPermissions(),
 				'title' => $item->getName(),
@@ -575,6 +583,7 @@ public function create($mimetype,
 		}
 
 		if (!$content){
+			// FIXME: see if this is used,
 			$content = file_get_contents(dirname(dirname(__DIR__)) . self::ODT_TEMPLATE_PATH);
 		}
 

diff --git a/lib/Listener/FileCreatedFromTemplateListener.php b/lib/Listener/FileCreatedFromTemplateListener.php
@@ -0,0 +1,71 @@
+<?php
+/*
+ * @copyright Copyright (c) 2021 Julius Härtl <[email protected]>
+ *
+ * @author Julius Härtl <[email protected]>
+ *
+ * @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/>.
+ *
+ */
+
+declare(strict_types=1);
+
+
+namespace OCA\Richdocuments\Listener;
+
+
+use OCA\Richdocuments\AppInfo\Application;
+use OCA\Richdocuments\TemplateManager;
+use OCP\EventDispatcher\Event;
+use OCP\EventDispatcher\IEventListener;
+use OCP\Files\Template\FileCreatedFromTemplateEvent;
+use OCP\IConfig;
+
+class FileCreatedFromTemplateListener implements IEventListener {
+
+	/** @var TemplateManager */
+	private $templateManager;
+
+	public function __construct(
+		TemplateManager $templateManager
+	) {
+		$this->templateManager = $templateManager;
+	}
+
+	public function handle(Event $event): void {
+		if (!($event instanceof FileCreatedFromTemplateEvent)) {
+			return;
+		}
+
+		$templateFile = $event->getTemplate();
+
+		// Empty template
+		if ($templateFile === null) {
+			$event->getTarget()->putContent($this->templateManager->getEmptyFileContent($event->getTarget()->getExtension()));
+			return;
+		}
+
+		if ($this->templateManager->isSupportedTemplateSource($templateFile->getExtension())) {
+			// Only use TemplateSource if supported filetype
+			$this->templateManager->setTemplateSource($event->getTarget()->getId(), $templateFile->getId());
+		}
+
+		// Avoid having the mimetype of the source file set
+		$event->getTarget()->getStorage()->getCache()->update($event->getTarget()->getId(), [
+			'mimetype' => $event->getTarget()->getMimeType()
+		]);
+	}
+}
diff --git a/lib/Migration/Version50200Date20211220212457.php b/lib/Migration/Version50200Date20211220212457.php
@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\Richdocuments\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+
+/**
+ * Auto-generated migration step: Please modify to your needs!
+ */
+class Version50200Date20211220212457 extends SimpleMigrationStep {
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+
+		if (!$schema->hasTable('richdocuments_template')) {
+			$table = $schema->createTable('richdocuments_template');
+			$table->addColumn('id', 'bigint', [
+				'autoincrement' => true,
+				'notnull' => true,
+				'length' => 20,
+				'unsigned' => true,
+			]);
+			$table->addColumn('userid', 'string', [
+				'notnull' => false,
+				'length' => 64,
+			]);
+			$table->addColumn('fileid', 'bigint', [
+				'notnull' => true,
+				'length' => 20,
+			]);
+			$table->addColumn('templateid', 'bigint', [
+				'notnull' => true,
+				'length' => 20,
+			]);
+			$table->addColumn('timestamp', 'bigint', [
+				'notnull' => true,
+				'length' => 20,
+				'unsigned' => true,
+			]);
+			$table->setPrimaryKey(['id']);
+			$table->addUniqueIndex(['userid', 'fileid'], 'rd_t_user_file');
+		}
+
+		return $schema;
+	}
+}
diff --git a/lib/Template/CollaboraTemplateProvider.php b/lib/Template/CollaboraTemplateProvider.php
@@ -73,8 +73,4 @@ public function getCustomTemplates(string $mimetype): array {
 	public function getCustomTemplate(string $template): File {
 		return $this->templateManager->get((int)$template);
 	}
-
-	public function createFromTemplate(File $template, File $target): void {
-		// TODO: Implement createFromTemplate() method.
-	}
 }