Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion appinfo/info.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
- **💾 Open format:** Files are saved as [Markdown](https://en.wikipedia.org/wiki/Markdown), so you can edit them from any other text app too.
- **✊ Strong foundation:** We use [🐈 tiptap](https://tiptap.scrumpy.io) which is based on [🦉 ProseMirror](https://prosemirror.net) – huge thanks to them!
]]></description>
<version>10.0.0-dev.3</version>
<version>10.0.0-dev.4</version>
<licence>agpl</licence>
<author mail="jus@bitgrid.net">Julius Härtl</author>
<namespace>Text</namespace>
Expand Down Expand Up @@ -48,5 +48,8 @@
<post-migration>
<step>OCA\Text\Migration\ResetSessionsBeforeYjs</step>
</post-migration>
<uninstall>
<step>OCA\Text\Migration\PurgeVersionSummaries</step>
</uninstall>
</repair-steps>
</info>
4 changes: 4 additions & 0 deletions appinfo/routes.php
Original file line number Diff line number Diff line change
Expand Up @@ -71,5 +71,9 @@
['name' => 'Workspace#direct', 'url' => '/workspace/direct', 'verb' => 'POST'],
/** @see Controller\VersionsController::index() */
['name' => 'Versions#index', 'url' => '/versions/{fileId}', 'verb' => 'GET'],
/** @see Controller\VersionSummaryController::lookup() */
['name' => 'VersionSummary#lookup', 'url' => '/version-summaries/{fileId}', 'verb' => 'GET'],
/** @see Controller\VersionSummaryController::generate() */
['name' => 'VersionSummary#generate', 'url' => '/version-summaries/{fileId}', 'verb' => 'POST'],
]
];
10 changes: 10 additions & 0 deletions composer/composer/autoload_classmap.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
'OCA\\Text\\Controller\\SettingsController' => $baseDir . '/../lib/Controller/SettingsController.php',
'OCA\\Text\\Controller\\TSessionAwareController' => $baseDir . '/../lib/Controller/TSessionAwareController.php',
'OCA\\Text\\Controller\\UserApiController' => $baseDir . '/../lib/Controller/UserApiController.php',
'OCA\\Text\\Controller\\VersionSummaryController' => $baseDir . '/../lib/Controller/VersionSummaryController.php',
'OCA\\Text\\Controller\\VersionsController' => $baseDir . '/../lib/Controller/VersionsController.php',
'OCA\\Text\\Controller\\WorkspaceController' => $baseDir . '/../lib/Controller/WorkspaceController.php',
'OCA\\Text\\Cron\\Cleanup' => $baseDir . '/../lib/Cron/Cleanup.php',
Expand All @@ -38,6 +39,8 @@
'OCA\\Text\\Db\\SessionMapper' => $baseDir . '/../lib/Db/SessionMapper.php',
'OCA\\Text\\Db\\Step' => $baseDir . '/../lib/Db/Step.php',
'OCA\\Text\\Db\\StepMapper' => $baseDir . '/../lib/Db/StepMapper.php',
'OCA\\Text\\Db\\VersionSummary' => $baseDir . '/../lib/Db/VersionSummary.php',
'OCA\\Text\\Db\\VersionSummaryMapper' => $baseDir . '/../lib/Db/VersionSummaryMapper.php',
'OCA\\Text\\DirectEditing\\TextDirectEditor' => $baseDir . '/../lib/DirectEditing/TextDirectEditor.php',
'OCA\\Text\\DirectEditing\\TextDocumentCreator' => $baseDir . '/../lib/DirectEditing/TextDocumentCreator.php',
'OCA\\Text\\Event\\DocumentContentUpdated' => $baseDir . '/../lib/Event/DocumentContentUpdated.php',
Expand All @@ -51,6 +54,8 @@
'OCA\\Text\\Exception\\InvalidSessionException' => $baseDir . '/../lib/Exception/InvalidSessionException.php',
'OCA\\Text\\Exception\\UploadException' => $baseDir . '/../lib/Exception/UploadException.php',
'OCA\\Text\\Exception\\VersionMismatchException' => $baseDir . '/../lib/Exception/VersionMismatchException.php',
'OCA\\Text\\Exception\\VersionNotFoundException' => $baseDir . '/../lib/Exception/VersionNotFoundException.php',
'OCA\\Text\\Exception\\VersionSummaryException' => $baseDir . '/../lib/Exception/VersionSummaryException.php',
'OCA\\Text\\Listeners\\AddMissingIndicesListener' => $baseDir . '/../lib/Listeners/AddMissingIndicesListener.php',
'OCA\\Text\\Listeners\\BeforeAssistantNotificationListener' => $baseDir . '/../lib/Listeners/BeforeAssistantNotificationListener.php',
'OCA\\Text\\Listeners\\BeforeNodeDeletedListener' => $baseDir . '/../lib/Listeners/BeforeNodeDeletedListener.php',
Expand All @@ -65,11 +70,13 @@
'OCA\\Text\\Listeners\\RegisterContextEventListener' => $baseDir . '/../lib/Listeners/RegisterContextEventListener.php',
'OCA\\Text\\Listeners\\RegisterDirectEditorEventListener' => $baseDir . '/../lib/Listeners/RegisterDirectEditorEventListener.php',
'OCA\\Text\\Listeners\\RegisterTemplateCreatorListener' => $baseDir . '/../lib/Listeners/RegisterTemplateCreatorListener.php',
'OCA\\Text\\Listeners\\TaskFinishedListener' => $baseDir . '/../lib/Listeners/TaskFinishedListener.php',
'OCA\\Text\\Listeners\\VersionRestoredListener' => $baseDir . '/../lib/Listeners/VersionRestoredListener.php',
'OCA\\Text\\Middleware\\Attribute\\RequireDocumentBaseVersionEtag' => $baseDir . '/../lib/Middleware/Attribute/RequireDocumentBaseVersionEtag.php',
'OCA\\Text\\Middleware\\Attribute\\RequireDocumentSession' => $baseDir . '/../lib/Middleware/Attribute/RequireDocumentSession.php',
'OCA\\Text\\Middleware\\Attribute\\RequireDocumentSessionOrUserOrShareToken' => $baseDir . '/../lib/Middleware/Attribute/RequireDocumentSessionOrUserOrShareToken.php',
'OCA\\Text\\Middleware\\SessionMiddleware' => $baseDir . '/../lib/Middleware/SessionMiddleware.php',
'OCA\\Text\\Migration\\PurgeVersionSummaries' => $baseDir . '/../lib/Migration/PurgeVersionSummaries.php',
'OCA\\Text\\Migration\\ResetSessionsBeforeYjs' => $baseDir . '/../lib/Migration/ResetSessionsBeforeYjs.php',
'OCA\\Text\\Migration\\Version010000Date20190617184535' => $baseDir . '/../lib/Migration/Version010000Date20190617184535.php',
'OCA\\Text\\Migration\\Version030001Date20200402075029' => $baseDir . '/../lib/Migration/Version030001Date20200402075029.php',
Expand All @@ -86,6 +93,7 @@
'OCA\\Text\\Migration\\Version090000Date20260819110024' => $baseDir . '/../lib/Migration/Version090000Date20260819110024.php',
'OCA\\Text\\Migration\\Version090000Date20260820132113' => $baseDir . '/../lib/Migration/Version090000Date20260820132113.php',
'OCA\\Text\\Migration\\Version100000Date20261011000000' => $baseDir . '/../lib/Migration/Version100000Date20261011000000.php',
'OCA\\Text\\Migration\\Version100000Date20261027120000' => $baseDir . '/../lib/Migration/Version100000Date20261027120000.php',
'OCA\\Text\\Model\\VersionEnd' => $baseDir . '/../lib/Model/VersionEnd.php',
'OCA\\Text\\Notification\\Notifier' => $baseDir . '/../lib/Notification/Notifier.php',
'OCA\\Text\\Service\\AiTagService' => $baseDir . '/../lib/Service/AiTagService.php',
Expand All @@ -100,6 +108,8 @@
'OCA\\Text\\Service\\NotificationService' => $baseDir . '/../lib/Service/NotificationService.php',
'OCA\\Text\\Service\\SessionService' => $baseDir . '/../lib/Service/SessionService.php',
'OCA\\Text\\Service\\VersionAccessService' => $baseDir . '/../lib/Service/VersionAccessService.php',
'OCA\\Text\\Service\\VersionSummaryPrompt' => $baseDir . '/../lib/Service/VersionSummaryPrompt.php',
'OCA\\Text\\Service\\VersionSummaryService' => $baseDir . '/../lib/Service/VersionSummaryService.php',
'OCA\\Text\\Service\\WorkspaceService' => $baseDir . '/../lib/Service/WorkspaceService.php',
'OCA\\Text\\TextFile' => $baseDir . '/../lib/TextFile.php',
'OCA\\Text\\YjsMessage' => $baseDir . '/../lib/YjsMessage.php',
Expand Down
10 changes: 10 additions & 0 deletions composer/composer/autoload_static.php
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ class ComposerStaticInitText
'OCA\\Text\\Controller\\SettingsController' => __DIR__ . '/..' . '/../lib/Controller/SettingsController.php',
'OCA\\Text\\Controller\\TSessionAwareController' => __DIR__ . '/..' . '/../lib/Controller/TSessionAwareController.php',
'OCA\\Text\\Controller\\UserApiController' => __DIR__ . '/..' . '/../lib/Controller/UserApiController.php',
'OCA\\Text\\Controller\\VersionSummaryController' => __DIR__ . '/..' . '/../lib/Controller/VersionSummaryController.php',
'OCA\\Text\\Controller\\VersionsController' => __DIR__ . '/..' . '/../lib/Controller/VersionsController.php',
'OCA\\Text\\Controller\\WorkspaceController' => __DIR__ . '/..' . '/../lib/Controller/WorkspaceController.php',
'OCA\\Text\\Cron\\Cleanup' => __DIR__ . '/..' . '/../lib/Cron/Cleanup.php',
Expand All @@ -53,6 +54,8 @@ class ComposerStaticInitText
'OCA\\Text\\Db\\SessionMapper' => __DIR__ . '/..' . '/../lib/Db/SessionMapper.php',
'OCA\\Text\\Db\\Step' => __DIR__ . '/..' . '/../lib/Db/Step.php',
'OCA\\Text\\Db\\StepMapper' => __DIR__ . '/..' . '/../lib/Db/StepMapper.php',
'OCA\\Text\\Db\\VersionSummary' => __DIR__ . '/..' . '/../lib/Db/VersionSummary.php',
'OCA\\Text\\Db\\VersionSummaryMapper' => __DIR__ . '/..' . '/../lib/Db/VersionSummaryMapper.php',
'OCA\\Text\\DirectEditing\\TextDirectEditor' => __DIR__ . '/..' . '/../lib/DirectEditing/TextDirectEditor.php',
'OCA\\Text\\DirectEditing\\TextDocumentCreator' => __DIR__ . '/..' . '/../lib/DirectEditing/TextDocumentCreator.php',
'OCA\\Text\\Event\\DocumentContentUpdated' => __DIR__ . '/..' . '/../lib/Event/DocumentContentUpdated.php',
Expand All @@ -66,6 +69,8 @@ class ComposerStaticInitText
'OCA\\Text\\Exception\\InvalidSessionException' => __DIR__ . '/..' . '/../lib/Exception/InvalidSessionException.php',
'OCA\\Text\\Exception\\UploadException' => __DIR__ . '/..' . '/../lib/Exception/UploadException.php',
'OCA\\Text\\Exception\\VersionMismatchException' => __DIR__ . '/..' . '/../lib/Exception/VersionMismatchException.php',
'OCA\\Text\\Exception\\VersionNotFoundException' => __DIR__ . '/..' . '/../lib/Exception/VersionNotFoundException.php',
'OCA\\Text\\Exception\\VersionSummaryException' => __DIR__ . '/..' . '/../lib/Exception/VersionSummaryException.php',
'OCA\\Text\\Listeners\\AddMissingIndicesListener' => __DIR__ . '/..' . '/../lib/Listeners/AddMissingIndicesListener.php',
'OCA\\Text\\Listeners\\BeforeAssistantNotificationListener' => __DIR__ . '/..' . '/../lib/Listeners/BeforeAssistantNotificationListener.php',
'OCA\\Text\\Listeners\\BeforeNodeDeletedListener' => __DIR__ . '/..' . '/../lib/Listeners/BeforeNodeDeletedListener.php',
Expand All @@ -80,11 +85,13 @@ class ComposerStaticInitText
'OCA\\Text\\Listeners\\RegisterContextEventListener' => __DIR__ . '/..' . '/../lib/Listeners/RegisterContextEventListener.php',
'OCA\\Text\\Listeners\\RegisterDirectEditorEventListener' => __DIR__ . '/..' . '/../lib/Listeners/RegisterDirectEditorEventListener.php',
'OCA\\Text\\Listeners\\RegisterTemplateCreatorListener' => __DIR__ . '/..' . '/../lib/Listeners/RegisterTemplateCreatorListener.php',
'OCA\\Text\\Listeners\\TaskFinishedListener' => __DIR__ . '/..' . '/../lib/Listeners/TaskFinishedListener.php',
'OCA\\Text\\Listeners\\VersionRestoredListener' => __DIR__ . '/..' . '/../lib/Listeners/VersionRestoredListener.php',
'OCA\\Text\\Middleware\\Attribute\\RequireDocumentBaseVersionEtag' => __DIR__ . '/..' . '/../lib/Middleware/Attribute/RequireDocumentBaseVersionEtag.php',
'OCA\\Text\\Middleware\\Attribute\\RequireDocumentSession' => __DIR__ . '/..' . '/../lib/Middleware/Attribute/RequireDocumentSession.php',
'OCA\\Text\\Middleware\\Attribute\\RequireDocumentSessionOrUserOrShareToken' => __DIR__ . '/..' . '/../lib/Middleware/Attribute/RequireDocumentSessionOrUserOrShareToken.php',
'OCA\\Text\\Middleware\\SessionMiddleware' => __DIR__ . '/..' . '/../lib/Middleware/SessionMiddleware.php',
'OCA\\Text\\Migration\\PurgeVersionSummaries' => __DIR__ . '/..' . '/../lib/Migration/PurgeVersionSummaries.php',
'OCA\\Text\\Migration\\ResetSessionsBeforeYjs' => __DIR__ . '/..' . '/../lib/Migration/ResetSessionsBeforeYjs.php',
'OCA\\Text\\Migration\\Version010000Date20190617184535' => __DIR__ . '/..' . '/../lib/Migration/Version010000Date20190617184535.php',
'OCA\\Text\\Migration\\Version030001Date20200402075029' => __DIR__ . '/..' . '/../lib/Migration/Version030001Date20200402075029.php',
Expand All @@ -101,6 +108,7 @@ class ComposerStaticInitText
'OCA\\Text\\Migration\\Version090000Date20260819110024' => __DIR__ . '/..' . '/../lib/Migration/Version090000Date20260819110024.php',
'OCA\\Text\\Migration\\Version090000Date20260820132113' => __DIR__ . '/..' . '/../lib/Migration/Version090000Date20260820132113.php',
'OCA\\Text\\Migration\\Version100000Date20261011000000' => __DIR__ . '/..' . '/../lib/Migration/Version100000Date20261011000000.php',
'OCA\\Text\\Migration\\Version100000Date20261027120000' => __DIR__ . '/..' . '/../lib/Migration/Version100000Date20261027120000.php',
'OCA\\Text\\Model\\VersionEnd' => __DIR__ . '/..' . '/../lib/Model/VersionEnd.php',
'OCA\\Text\\Notification\\Notifier' => __DIR__ . '/..' . '/../lib/Notification/Notifier.php',
'OCA\\Text\\Service\\AiTagService' => __DIR__ . '/..' . '/../lib/Service/AiTagService.php',
Expand All @@ -115,6 +123,8 @@ class ComposerStaticInitText
'OCA\\Text\\Service\\NotificationService' => __DIR__ . '/..' . '/../lib/Service/NotificationService.php',
'OCA\\Text\\Service\\SessionService' => __DIR__ . '/..' . '/../lib/Service/SessionService.php',
'OCA\\Text\\Service\\VersionAccessService' => __DIR__ . '/..' . '/../lib/Service/VersionAccessService.php',
'OCA\\Text\\Service\\VersionSummaryPrompt' => __DIR__ . '/..' . '/../lib/Service/VersionSummaryPrompt.php',
'OCA\\Text\\Service\\VersionSummaryService' => __DIR__ . '/..' . '/../lib/Service/VersionSummaryService.php',
'OCA\\Text\\Service\\WorkspaceService' => __DIR__ . '/..' . '/../lib/Service/WorkspaceService.php',
'OCA\\Text\\TextFile' => __DIR__ . '/..' . '/../lib/TextFile.php',
'OCA\\Text\\YjsMessage' => __DIR__ . '/..' . '/../lib/YjsMessage.php',
Expand Down
5 changes: 5 additions & 0 deletions lib/AppInfo/Application.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
use OCA\Text\Listeners\RegisterContextEventListener;
use OCA\Text\Listeners\RegisterDirectEditorEventListener;
use OCA\Text\Listeners\RegisterTemplateCreatorListener;
use OCA\Text\Listeners\TaskFinishedListener;
use OCA\Text\Listeners\VersionRestoredListener;
use OCA\Text\Middleware\SessionMiddleware;
use OCA\Text\Notification\Notifier;
Expand All @@ -44,6 +45,8 @@
use OCP\Files\Events\Node\NodeCopiedEvent;
use OCP\Files\Events\Node\NodeWrittenEvent;
use OCP\Files\Template\RegisterTemplateCreatorEvent;
use OCP\TaskProcessing\Events\TaskFailedEvent;
use OCP\TaskProcessing\Events\TaskSuccessfulEvent;

class Application extends App implements IBootstrap {
public const string APP_NAME = 'text';
Expand Down Expand Up @@ -73,6 +76,8 @@ public function register(IRegistrationContext $context): void {

$context->registerEventListener(RegisterContextEvent::class, RegisterContextEventListener::class);
$context->registerEventListener(DocumentContentUpdated::class, DocumentContentUpdatedListener::class);
$context->registerEventListener(TaskSuccessfulEvent::class, TaskFinishedListener::class);
$context->registerEventListener(TaskFailedEvent::class, TaskFinishedListener::class);

$context->registerNotifierService(Notifier::class);
$context->registerMiddleware(SessionMiddleware::class);
Expand Down
28 changes: 28 additions & 0 deletions lib/ConfigLexicon.php
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,34 @@ public function getAppConfigs(): array {
definition: 'Delay before editor switches to read-onl when offline (in seconds)',
lazy: false,
),
new Entry(
key: 'version_summaries_enabled',
type: ValueType::BOOL,
defaultRaw: false,
definition: 'Whether people can summarize the changes between two versions of a Markdown file with the configured AI provider',
lazy: false,
),
new Entry(
key: 'version_summaries_hourly_limit',
type: ValueType::INT,
defaultRaw: 60,
definition: 'How many summaries of changes the whole instance may start per hour',
lazy: true,
),
new Entry(
key: 'version_summaries_user_hourly_limit',
type: ValueType::INT,
defaultRaw: 10,
definition: 'How many summaries of changes one person may start per hour',
lazy: true,
),
new Entry(
key: 'version_summaries_max_input_bytes',
type: ValueType::INT,
defaultRaw: 240_000,
definition: 'Largest input in bytes, both versions and the instructions, sent to the AI provider for a summary of changes (at most 480000)',
lazy: true,
),
];
}

Expand Down
77 changes: 77 additions & 0 deletions lib/Controller/VersionSummaryController.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
<?php

declare(strict_types=1);

/**
* SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/

namespace OCA\Text\Controller;

use OCA\Text\Exception\VersionSummaryException;
use OCA\Text\Service\VersionSummaryService;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\Attribute\NoAdminRequired;
use OCP\AppFramework\Http\Attribute\UserRateLimit;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\OCSController;
use OCP\IRequest;
use OCP\IUserSession;

class VersionSummaryController extends OCSController {
public function __construct(
string $appName,
IRequest $request,
private readonly VersionSummaryService $versionSummaryService,
private readonly IUserSession $userSession,
) {
parent::__construct($appName, $request);
}

/**
* The summary of the changes between two exact texts of a file, if there
* is one, and whether one can be made. Starts nothing.
*
* @param int $fileId Id of the file
* @param string $from The older end: `current` or a revision
* @param string $to The newer end
* @param string $fromHash SHA-256 of the older text, as the browser loaded it
* @param string $toHash SHA-256 of the newer text
*/
#[NoAdminRequired]
public function lookup(int $fileId, string $from, string $to, string $fromHash, string $toHash): DataResponse {
return $this->respond(fn ($user) => $this->versionSummaryService->lookup($user, $fileId, $from, $to, $fromHash, $toHash));
}

/**
* Start summarizing the changes between two exact texts of a file
*
* @param int $fileId Id of the file
* @param string $from The older end: `current` or a revision
* @param string $to The newer end
* @param string $fromHash SHA-256 of the older text, as the browser loaded it
* @param string $toHash SHA-256 of the newer text
*/
#[NoAdminRequired]
// The browser waits out the same period after a refusal: RATE_LIMIT_SECONDS in src/versionSummary/states.ts
#[UserRateLimit(limit: 5, period: 120)]
public function generate(int $fileId, string $from, string $to, string $fromHash, string $toHash): DataResponse {
return $this->respond(fn ($user) => $this->versionSummaryService->generate($user, $fileId, $from, $to, $fromHash, $toHash));
}

/**
* @param callable(\OCP\IUser): array<string, mixed> $answer
*/
private function respond(callable $answer): DataResponse {
$user = $this->userSession->getUser();
if ($user === null) {
return new DataResponse(['error' => 'not_found'], Http::STATUS_NOT_FOUND);
}
try {
return new DataResponse($answer($user));
} catch (VersionSummaryException $e) {
return new DataResponse(['error' => $e->reason, 'retryAfter' => $e->retryAfter], $e->status);
}
}
}
9 changes: 9 additions & 0 deletions lib/Cron/Cleanup.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use OCA\Text\Service\AttachmentService;
use OCA\Text\Service\DocumentService;
use OCA\Text\Service\SessionService;
use OCA\Text\Service\VersionSummaryService;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\BackgroundJob\TimedJob;
use OCP\Files\ISetupManager;
Expand All @@ -26,6 +27,7 @@ public function __construct(
private readonly AttachmentService $attachmentService,
private readonly LoggerInterface $logger,
private readonly ISetupManager $setupManager,
private readonly VersionSummaryService $versionSummaryService,
) {
parent::__construct($time);
$this->setInterval(SessionService::SESSION_VALID_TIME);
Expand Down Expand Up @@ -65,5 +67,12 @@ protected function run($argument): void {

$this->logger->debug('Run cleanup job for obsolete documents folders');
$this->documentService->cleanupOldDocumentsFolders();

$this->logger->debug('Run cleanup job for summaries of changes');
try {
$this->versionSummaryService->cleanup();
} catch (\Throwable $e) {
$this->logger->error('Could not clean up summaries of changes', ['exception' => $e]);
}
}
}
Loading
Loading