feat: implement intros

Signed-off-by: Vitor Mattos <vitor@php.rio>
LibreSign · Jul 15, 2024 · 76f8cd6 · 76f8cd6
1 parent 88167a0
commit 76f8cd6
Show file tree

Hide file tree

Showing 3 changed files with 113 additions and 0 deletions.
diff --git a/lib/AppInfo/Application.php b/lib/AppInfo/Application.php
@@ -9,11 +9,13 @@
 namespace OCA\Libresign\AppInfo;
 
 use OCA\Files\Event\LoadSidebar;
+use OCA\Intros\Events\FetchIntrosEvent;
 use OCA\Libresign\Activity\Listener as ActivityListener;
 use OCA\Libresign\Events\SendSignNotificationEvent;
 use OCA\Libresign\Events\SignedEvent;
 use OCA\Libresign\Files\TemplateLoader as FilesTemplateLoader;
 use OCA\Libresign\Listener\BeforeNodeDeletedListener;
+use OCA\Libresign\Listener\FetchIntrosListener;
 use OCA\Libresign\Listener\LoadSidebarListener;
 use OCA\Libresign\Listener\MailNotifyListener;
 use OCA\Libresign\Listener\NotificationListener;
@@ -69,5 +71,7 @@ public function register(IRegistrationContext $context): void {
 		$context->registerEventListener(SendSignNotificationEvent::class, MailNotifyListener::class);
 
 		$context->registerEventListener(UserDeletedEvent::class, UserDeletedListener::class);
+
+		$context->registerEventListener(FetchIntrosEvent::class, FetchIntrosListener::class);
 	}
 }
diff --git a/lib/Listener/FetchIntrosListener.php b/lib/Listener/FetchIntrosListener.php
@@ -0,0 +1,91 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2024-2024 LibreCode coop and contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Libresign\Listener;
+
+use OCA\Files\Event\LoadSidebar;
+use OCA\Intros\Events\FetchIntrosEvent;
+use OCA\Libresign\AppInfo\Application;
+use OCA\Libresign\Handler\CertificateEngine\Handler as CertificateEngineHandler;
+use OCP\EventDispatcher\Event;
+use OCP\EventDispatcher\IEventListener;
+use OCP\IL10N;
+
+/**
+ * @template-implements IEventListener<Event|LoadSidebar>
+ */
+class FetchIntrosListener implements IEventListener {
+	public function __construct(
+		private IL10N $l10n,
+		private CertificateEngineHandler $certificateEngineHandler,
+	) {
+	}
+
+	public function handle(Event $event): void {
+		if (!($event instanceof FetchIntrosEvent)) {
+			return;
+		}
+		if (!$this->certificateEngineHandler->getEngine()->isSetupOk()) {
+			return;
+		}
+		$event->setData([
+			Application::APP_ID => [
+				'name' => $this->l10n->t('LibreSign'),
+				'steps' => [
+					[
+						'title' => $this->l10n->t('Welcome!'),
+						'paragraphs' => [
+							$this->l10n->t('The LibreSign app allows you to sign documents using your digital certificate or the certificate generated by LibreSign.'),
+						],
+						'choices' => [
+							[
+								'success' => false,
+								'label' => $this->l10n->t('Skip this tutorial'),
+							]
+						],
+						'element' => '',
+					],
+					[
+						'paragraphs' => [
+							$this->l10n->t('Choose the file to request signatures.'),
+						],
+						'element' => 'div#container-request',
+					],
+					[
+						'paragraphs' => [
+							$this->l10n->t('List the files that are associated to you.'),
+						],
+						'element' => 'li#timeline',
+					],
+					[
+						'paragraphs' => [
+							$this->l10n->t('Validate signature'),
+						],
+						'element' => 'li#validation',
+					],
+					[
+						'title' => $this->l10n->t('Settings'),
+						'paragraphs' => [
+							$this->l10n->t('Your personal settings.'),
+							$this->l10n->t('Here you can manage your digital certificate or your visible signature.'),
+						],
+						'element' => 'div#app-settings',
+						'open' => 'div#app-settings__header > .settings-button',
+						'position' => 'top',
+					],
+					[
+						'title' => 'See you!',
+						'paragraphs' => [
+							$this->l10n->t('Help maintain the development of this app by contributing via GitHub Sponsors.'),
+						],
+					],
+				],
+			],
+		]);
+	}
+}
diff --git a/tests/psalm-baseline.xml b/tests/psalm-baseline.xml
@@ -2,9 +2,13 @@
 <files psalm-version="5.25.0@01a8eb06b9e9cc6cfb6a320bf9fb14331919d505">
   <file src="lib/AppInfo/Application.php">
     <InvalidArgument>
+      <code><![CDATA[FetchIntrosListener::class]]></code>
       <code><![CDATA[LoadSidebarListener::class]]></code>
       <code><![CDATA[registerEventListener]]></code>
     </InvalidArgument>
+    <UndefinedClass>
+      <code><![CDATA[FetchIntrosEvent]]></code>
+    </UndefinedClass>
   </file>
   <file src="lib/Command/Configure/Cfssl.php">
     <MissingDependency>
@@ -74,6 +78,20 @@
       <code><![CDATA[Pagination]]></code>
     </MissingTemplateParam>
   </file>
+  <file src="lib/Listener/FetchIntrosListener.php">
+    <InvalidTemplateParam>
+      <code><![CDATA[IEventListener]]></code>
+    </InvalidTemplateParam>
+    <MoreSpecificImplementedParamType>
+      <code><![CDATA[$event]]></code>
+    </MoreSpecificImplementedParamType>
+    <UndefinedClass>
+      <code><![CDATA[FetchIntrosEvent]]></code>
+    </UndefinedClass>
+    <UndefinedDocblockClass>
+      <code><![CDATA[FetchIntrosListener]]></code>
+    </UndefinedDocblockClass>
+  </file>
   <file src="lib/Listener/LoadSidebarListener.php">
     <InvalidTemplateParam>
       <code><![CDATA[IEventListener]]></code>