Data source for the Analytics App

.github/workflows/phpunit-mariadb.yml

@@ -93,7 +93,7 @@ jobs:
         with:
           path: apps/${{ env.APP_NAME }}
 
-      - name: Checkout circles dependency
+      - name: Checkout teams dependency
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
         with:
           repository: nextcloud/circles

.github/workflows/phpunit-mysql.yml

@@ -91,7 +91,7 @@ jobs:
         with:
           path: apps/${{ env.APP_NAME }}
 
-      - name: Checkout circles dependency
+      - name: Checkout teams dependency
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
         with:
           repository: nextcloud/circles

.github/workflows/phpunit-oci.yml

@@ -104,7 +104,7 @@ jobs:
         with:
           path: apps/${{ env.APP_NAME }}
 
-      - name: Checkout circles dependency
+      - name: Checkout teams dependency
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
         with:
           repository: nextcloud/circles

.github/workflows/phpunit-pgsql.yml

@@ -94,7 +94,7 @@ jobs:
         with:
           path: apps/${{ env.APP_NAME }}
 
-      - name: Checkout circles dependency
+      - name: Checkout teams dependency
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
         with:
           repository: nextcloud/circles

.github/workflows/phpunit-sqlite.yml

@@ -89,13 +89,20 @@ jobs:
         with:
           path: apps/${{ env.APP_NAME }}
 
-      - name: Checkout circles dependency
+      - name: Checkout teams app
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
         with:
           repository: nextcloud/circles
           ref: ${{ matrix.server-versions }}
           path: apps/circles
 
+      - name: Checkout analytics app
+        uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+        with:
+          repository: rello/analytics
+          ref: master
+          path: apps/analytics
+
       - name: Set up php ${{ matrix.php-versions }}
         uses: shivammathur/setup-php@2e947f1f6932d141d076ca441d0e1e881775e95b # v2
         with:

lib/Analytics/AnalyticsDatasource.php

@@ -0,0 +1,154 @@
+<?php
+/**
+ * Analytics data source
+ * Report Table App data with the Analytics App
+ *
+ * This file is licensed under the Affero General Public License version 3 or
+ * later. See the LICENSE.md file.
+ *
+ * @author Marcel Scherello <[email protected]>
+ */
+
+namespace OCA\Forms\Analytics;
+
+/** @psalm-suppress UndefinedClass */
+use OCA\Analytics\Datasource\IDatasource;
+use OCA\Forms\Db\FormMapper;
+use OCA\Forms\Service\FormsService;
+use OCA\Forms\Service\SubmissionService;
+use OCP\IL10N;
+use Psr\Log\LoggerInterface;
+
+class AnalyticsDatasource implements IDatasource {
+
+	public function __construct(
+		protected ?string $userId,
+		private IL10N $l10n,
+		private LoggerInterface $logger,
+		private FormMapper $formMapper,
+		private FormsService $formsService,
+		private SubmissionService $submissionService,
+	) {
+	}
+
+	/**
+	 * @return string Display Name of the datasource
+	 */
+	public function getName(): string {
+		return $this->l10n->t('Nextcloud Forms');
+	}
+
+	/**
+	 * @return int 2 digit unique datasource id
+	 */
+	public function getId(): int {
+		return 66;
+	}
+
+	/**
+	 * available options of the data source
+	 *
+	 * return needs to be an array and can consist of many fields.
+	 * every field needs to provide the following format
+	 *  id          *mandatory*     = name of the option for the readData
+	 *  name        *mandatory*     = displayed name of the input field in the UI
+	 *  type        *optional*      = 'tf' to create a dropdown. Values need to be provided in the placeholder separated with "/".
+	 *  placeholder *mandatory*     = help text for the input field in the UI
+	 *                                for type=tf:
+	 *                                  e.g. "true/false"
+	 *                                  if value/text pairs are required for the dropdown/option, the values need to be separated with "-" in addition.
+	 *                                  e.g. "eq-equal/gt-greater"
+	 *                                  to avoid translation of the technical strings, separate them
+	 *                                  'true-' - $this->l10n->t('Yes').'/false-'.$this->l10n->t('No')
+	 *
+	 *  example:
+	 *  {['id' => 'datatype', 'name' => 'Type of Data', 'type' => 'tf', 'placeholder' => 'adaptation/absolute']}
+	 *
+	 * @return array
+	 */
+	public function getTemplate(): array {
+		$formsString = '';
+		$questionString = '';
+		$template = [];
+
+		$forms = $this->formMapper->findAllByOwnerId($this->userId);
+		foreach ($forms as $form) {
+			$formsString = $formsString . $form->getId() . '-' . $form->getTitle() . '/';
+			/* Questions are not yet required
+			$questions = $this->formsService->getQuestions($form->getId());
+			foreach ($questions as $question) {
+				$questionString = $questionString . $question['id'] . '-' . $question['text'] . '/';
+			}*/
+		}
+
+		// add the tables to a dropdown in the data source settings
+		$template[] = ['id' => 'formId', 'name' => $this->l10n->t('Select form'), 'type' => 'tf', 'placeholder' => $formsString];
+		$template[] = ['id' => 'timestamp', 'name' => $this->l10n->t('Timestamp of data load'), 'placeholder' => 'false-' . $this->l10n->t('No') . '/true-' . $this->l10n->t('Yes'), 'type' => 'tf'];
+		return $template;
+	}
+
+	/**
+	 * Read the Data
+	 *
+	 * return needs to be an array
+	 *  [
+	 *      'header' => $header,  //array('column header 1', 'column header 2','column header 3')
+	 *      'dimensions' => array_slice($header, 0, count($header) - 1),
+	 *      'data' => $data,
+	 *      'error' => 0,         // INT 0 = no error
+	 *  ]
+	 *
+	 * @param array $option
+	 * @return array
+	 */
+	public function readData($option): array {
+		$questionMap = [];
+		$answerCounts = [];
+
+		$formId = $option['formId'];
+
+		$questions = $this->formsService->getQuestions($formId);
+		foreach ($questions as $question) {
+			$questionMap[$question['id']] = $question['text'];
+		}
+
+		$submissions = $this->submissionService->getSubmissions($formId);
+		foreach ($submissions as $submission) {
+			foreach ($submission['answers'] as $answer) {
+				$questionText = $questionMap[$answer['questionId']];
+				$key = $questionText . '|' . $answer['text'];
+				if (isset($answerCounts[$key])) {
+					$answerCounts[$key]++;
+				} else {
+					$answerCounts[$key] = 1;
+				}
+			}
+		}
+
+		foreach ($answerCounts as $key => $count) {
+			[$questionText, $text] = explode('|', $key);
+			$results[] = [$questionText, $text, $count];
+		}
+
+		// Sort by questionText ascending and count descending
+		usort($results, function ($a, $b) {
+			if ($a[0] === $b[0]) {
+				return $b[2] <=> $a[2];
+			}
+			return $a[0] <=> $b[0];
+		});
+
+		$header = [];
+		$header[0] = $this->l10n->t('Question');
+		$header[1] = $this->l10n->t('Answer');
+		$header[2] = $this->l10n->t('Count');
+
+		return [
+			'header' => $header,
+			'dimensions' => array_slice($header, 0, count($header) - 1),
+			'data' => $results,
+			//'rawdata' => $data,
+			'error' => 0,
+		];
+	}
+}

lib/AppInfo/Application.php

@@ -28,8 +28,10 @@
 
 namespace OCA\Forms\AppInfo;
 
+use OCA\Analytics\Datasource\DatasourceEvent;
 use OCA\Forms\Capabilities;
 use OCA\Forms\FormsMigrator;
+use OCA\Forms\Listener\AnalyticsDatasourceListener;
 use OCA\Forms\Listener\UserDeletedListener;
 use OCP\AppFramework\App;
 use OCP\AppFramework\Bootstrap\IBootContext;
@@ -58,6 +60,7 @@
 
 		$context->registerCapability(Capabilities::class);
 		$context->registerEventListener(UserDeletedEvent::class, UserDeletedListener::class);
+		$context->registerEventListener(DatasourceEvent::class, AnalyticsDatasourceListener::class);
 		$context->registerUserMigrator(FormsMigrator::class);
 	}
 

lib/Listener/AnalyticsDatasourceListener.php

@@ -0,0 +1,31 @@
+<?php
+/**
+ * Analytics data source
+ * Report Table App data with the Analytics App
+ *
+ * This file is licensed under the Affero General Public License version 3 or
+ * later. See the LICENSE.md file.
+ *
+ * @author Marcel Scherello <[email protected]>
+ */
+declare(strict_types=1);
+
+namespace OCA\Forms\Listener;
+
+use OCA\Analytics\Datasource\DatasourceEvent;
+use OCA\Forms\Analytics\AnalyticsDatasource;
+use OCP\EventDispatcher\Event;
+use OCP\EventDispatcher\IEventListener;
+
+/**
+ * @template-implements IEventListener<DatasourceEvent>
+ */
+class AnalyticsDatasourceListener implements IEventListener {
+	public function handle(Event $event): void {
+		if (!($event instanceof DatasourceEvent)) {
+			// Unrelated
+			return;
+		}
+		$event->registerDatasource(AnalyticsDatasource::class);
+	}
+}

psalm.xml

@@ -27,6 +27,8 @@
 				<referencedClass name="OCA\Circles\CirclesManager" />
 				<referencedClass name="OCA\Circles\Model\Circle" />
 				<referencedClass name="OCA\Circles\Model\Member" />
+				<referencedClass name="OCA\Analytics\Datasource\IDatasource" />
+				<referencedClass name="OCA\Analytics\Datasource\DatasourceEvent" />
 			</errorLevel>
 		</UndefinedClass>
 		<UndefinedDocblockClass>
@@ -35,10 +37,12 @@
 				<referencedClass name="Doctrine\DBAL\Schema\SchemaException" />
 				<referencedClass name="Doctrine\DBAL\Driver\Statement" />
 				<referencedClass name="Doctrine\DBAL\Schema\Table" />
+				<referencedClass name="OCA\Analytics\Datasource\DatasourceEvent" />
 			</errorLevel>
 		</UndefinedDocblockClass>
 	</issueHandlers>
 	<stubs>
 		<file name="tests/stubs/oc_hooks_emitter.php" />
+		<file name="tests/stubs/oca-analytics-idatasource.php" />
 	</stubs>
 </psalm>