feat(settings): add admin & user setting iframe #4373

codewithvk · 2025-01-07T16:59:25Z

Resolves: #
Target version: main

Summary

TODO

...

Checklist

Code is properly formatted
Sign-off message is added to all commits
Documentation (manuals or wiki) has been updated or is not required

juliusknorr

Some early feedback, general approach seems good 👍

juliusknorr · 2025-01-07T17:03:59Z

lib/Controller/DocumentController.php

+				$wopi = $this->tokenManager->generateWopiToken($fileId, null, $adminUserId);
+
+				$coolBaseUrl = $this->appConfig->getCollaboraUrlPublic();
+				$adminSettingsWopiSrc = $coolBaseUrl . '/browser/admin-settings.html?';


Ideally this would be an URL that can be obtained from the discovery endpoint of Collabora, could be a separate app element for settings

Added to my TODO, will fix it before merging PR.

lib/TokenManager.php

lib/Db/WopiMapper.php

lib/Controller/DocumentController.php

lib/Service/SettingsService.php

codewithvk · 2025-01-11T19:00:20Z

Related serverside PR : nextcloud/server#50145

pedropintosilva · 2025-01-15T09:45:28Z

@codewithvk @juliusknorr thanks. Probably worth to create a separated PR for the vue conversion, right?

elzody · 2025-01-22T18:17:21Z

In order to resolve the failing tests, you should do the following:

Make sure all the new files (and existing files, even) have the SPDX reuse header at the top
Run composer run cs:fix to address formatting and styling issues, etc.
Run composer run psalm -- --no-cache which will inform you of errors which should be fixed

Signed-off-by: codewithvk <[email protected]>

…directories Signed-off-by: codewithvk <[email protected]>

…y of user and system settings. Note: We will delete this commit/code after the entire prototype is ready. Reviewers can ignore this commit during the review process. Signed-off-by: codewithvk <[email protected]>

TODO: We should try to centralize the path everywhere so that a change in one place updates it everywhere! Signed-off-by: codewithvk <[email protected]>

… it to system-settings dir Signed-off-by: codewithvk <[email protected]>

…equest Signed-off-by: codewithvk <[email protected]>

- Implement dynamic routing for settings files, enabling URLs structured as /settings/{type}/{category}/{filename}. - Support various setting types (e.g. userconfigs, sharedconfigs) and categories (e.g. autotext, wordbook) so that multiple files can be stored for each category. - Ensure proper URL parsing and directory handling for uploading and retrieving files via the WOPI interface. Signed-off-by: codewithvk <[email protected]>

Signed-off-by: codewithvk <[email protected]>

codewithvk · 2025-01-23T07:24:05Z

In order to resolve the failing tests, you should do the following:

Make sure all the new files (and existing files, even) have the SPDX reuse header at the top

Run composer run cs:fix to address formatting and styling issues, etc.

Run composer run psalm -- --no-cache which will inform you of errors which should be fixed

@elzody We could have one psalm error because we need to merge PR :nextcloud/server#50145 before.. I fixed other errors...Also could you please run CI - as I don't have access to run CI.

Signed-off-by: codewithvk <[email protected]>

src/components/AdminSettings.vue

juliusknorr · 2025-01-23T10:48:56Z

src/components/PersonalSettings.vue

@@ -34,6 +34,17 @@
 			</em>
 		</p>

+		<!-- user settings iframe  -->
+		<div id="user-cool-frame-section" class="section">
+			<h2>{{ t('richdocuments', 'Collabora User Settings') }}</h2>


We should call this differently as we want to remove the duplicate word "settings" from all seections we have (ref #4351)

How it looks now:

I have discussed with Vivek that we should also remove Collabora since it's part of Office settings section.

If we also remove settings (even thought I do see "Personal settings" in the #4351 you have referenced) then we either replace it with something such as "preferences" or - and I think better - we simply remove that h2 completely and let the headings in the iframe being h2 (so, autotext and workbook will become upper level which probably makes more sense)

@pedropintosilva Thanks for adding a screenshot :)

juliusknorr · 2025-01-23T10:49:31Z

@codewithvk Can you also add some screenshots of how this looks in the settings page for review of @marcoambrosini as designer?

Signed-off-by: codewithvk <[email protected]>

…om iframe Signed-off-by: codewithvk <[email protected]>

codewithvk · 2025-01-24T06:35:24Z

@juliusknorr @elzody I'm not able to figure out why wopi integration for db test broken, any idea?

codewithvk · 2025-01-24T07:36:09Z

Modified bit of UI of iframe

cc: @marcoambrosini @juliusknorr @pedropintosilva

pedropintosilva · 2025-01-24T07:46:29Z

Modified bit of UI of iframe

cc: @marcoambrosini @juliusknorr @pedropintosilva

Awesome, much better, thanks!

I think We can still make it more clear in terms of the elements and their relation. What I mean is that right now the "Upload AutoText/Wordbook" buttons seem that they are referring to the list of files (which is not the case, those files were already uploaded). Best to clarify the main action by renaming it to "Add new AutoText" / "Add new Wordbook" but that seems a bit too long (specially when considering translations) -> so, what about "New AutoText" and "New Wordbook". I have noticed that in https://nextcloud-vue-components.netlify.app/#/Components/App%20containers/NcAppNavigation?id=ncappnavigationnewitem that sometimes they use the additional plus icon as a prefix (Maybe we could use it? @jancborchardt , @marcoambrosini )

Signed-off-by: codewithvk <[email protected]>

juliusknorr · 2025-01-24T14:17:10Z

lib/Service/SettingsService.php

+		try {
+			$categories = [];
+			$folder = $this->appData->getFolder($type);
+			$directories = $folder->getFullDirectoryListing();


Sorry I missed that the server change was also required, but we cannot get that in for 31 anymore due to API freeze.

However you can directly access it by injecting IRootFolder and then fetching the path directly from it

$instanceId = $this->config->getSystemValue('instanceid', null); if ($instanceId === null) { } return $this->rootFolder->get('appdata_' . $instanceId . '/richdocuments/your-path');

@juliusknorr Is it safe to access the rootFolder from a security perspective?

May be for now we can do it as it seems we don't have other options.

Yes, that is fine, the server API that you have would do similar calls

codewithvk requested review from elzody and juliusknorr as code owners January 7, 2025 16:59

codewithvk force-pushed the private/codewithvk/cool_setting_iframe branch from 62c98ce to 104c780 Compare January 7, 2025 17:02

codewithvk marked this pull request as draft January 7, 2025 17:04

juliusknorr reviewed Jan 7, 2025

View reviewed changes

codewithvk commented Jan 10, 2025

View reviewed changes

lib/Service/SettingsService.php Outdated Show resolved Hide resolved

codewithvk force-pushed the private/codewithvk/cool_setting_iframe branch from 905e1e2 to cc91ef8 Compare January 11, 2025 18:22

codewithvk requested a review from juliusknorr January 20, 2025 07:55

codewithvk force-pushed the private/codewithvk/cool_setting_iframe branch from c042023 to 5e11402 Compare January 20, 2025 10:56

codewithvk marked this pull request as ready for review January 21, 2025 12:34

This comment was marked as spam.

Sign in to view

github-actions bot added the feedback-requested label Jan 22, 2025

codewithvk added 15 commits January 23, 2025 11:21

Initial cool admin setting iframe setup

7f1b1f8

Signed-off-by: codewithvk <[email protected]>

WIP auth

ab2f3c2

Signed-off-by: codewithvk <[email protected]>

Temp: Auth handling stuff

3c2cd76

Signed-off-by: codewithvk <[email protected]>

WIP: wopi setting upload

13d9e71

Signed-off-by: codewithvk <[email protected]>

Created an AppData-based directory for system settings and user settings

8fb8cd5

Signed-off-by: codewithvk <[email protected]>

Create a Settings controller API endpoint for handling AppData-based …

14799b9

…directories Signed-off-by: codewithvk <[email protected]>

Change the admin settings iframe URL to adminIntegratorSettings.

29fb5f3

TODO: We should try to centralize the path everywhere so that a change in one place updates it everywhere! Signed-off-by: codewithvk <[email protected]>

WOPI: Update the wopi setting upload route to accept a file and store…

b97570f

… it to system-settings dir Signed-off-by: codewithvk <[email protected]>

add delete button and create wopi/setting route to handle wopi file r…

202dae7

…equest Signed-off-by: codewithvk <[email protected]>

Code cleanup: Remove POC helper functions

f6e45b1

Signed-off-by: codewithvk <[email protected]>

Send WOPI setting base URL to integrator

1225224

Signed-off-by: codewithvk <[email protected]>

fix: fetch config url

91d2cad

Signed-off-by: codewithvk <[email protected]>

wopi: add delete setting file route

6b7754c

Signed-off-by: codewithvk <[email protected]>

codewithvk added 2 commits January 23, 2025 11:21

refactor: token generation for iframe

c962471

Signed-off-by: codewithvk <[email protected]>

feat(user-settings): introduce iframe for user settings

bf5a8bf

Signed-off-by: codewithvk <[email protected]>

codewithvk force-pushed the private/codewithvk/cool_setting_iframe branch from 5e11402 to bf5a8bf Compare January 23, 2025 05:54

fix: linting issue for CI

e7023ad

Signed-off-by: codewithvk <[email protected]>

codewithvk changed the title ~~WIP: Admin setting iframe~~ Admin & User setting iframe Jan 23, 2025

codewithvk changed the title ~~Admin & User setting iframe~~ feat(settings): add admin & user setting iframe Jan 23, 2025

fix: generate token for user shared config url

362eaf1

Signed-off-by: codewithvk <[email protected]>

juliusknorr reviewed Jan 23, 2025

View reviewed changes

src/components/AdminSettings.vue Outdated Show resolved Hide resolved

juliusknorr reviewed Jan 23, 2025

View reviewed changes

codewithvk added 2 commits January 23, 2025 16:46

fix: accept document and setting url token for file upload

557305a

Signed-off-by: codewithvk <[email protected]>

fix: set proper WOPI response and remove unnecessary WOPI callback fr…

c49acd5

…om iframe Signed-off-by: codewithvk <[email protected]>

fix(settings): remove iframe title and section

235882e

Signed-off-by: codewithvk <[email protected]>

juliusknorr reviewed Jan 24, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(settings): add admin & user setting iframe #4373

feat(settings): add admin & user setting iframe #4373

codewithvk commented Jan 7, 2025

juliusknorr left a comment

juliusknorr Jan 7, 2025

codewithvk Jan 19, 2025

codewithvk commented Jan 11, 2025

pedropintosilva commented Jan 15, 2025

This comment was marked as spam.

elzody commented Jan 22, 2025

codewithvk commented Jan 23, 2025 •

edited

Loading

juliusknorr Jan 23, 2025

pedropintosilva Jan 23, 2025

codewithvk Jan 23, 2025

juliusknorr commented Jan 23, 2025

codewithvk commented Jan 24, 2025

codewithvk commented Jan 24, 2025

pedropintosilva commented Jan 24, 2025 •

edited

Loading

juliusknorr Jan 24, 2025

codewithvk Jan 24, 2025

juliusknorr Jan 24, 2025

feat(settings): add admin & user setting iframe #4373

Are you sure you want to change the base?

feat(settings): add admin & user setting iframe #4373

Conversation

codewithvk commented Jan 7, 2025

Summary

TODO

Checklist

juliusknorr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codewithvk commented Jan 11, 2025

pedropintosilva commented Jan 15, 2025

This comment was marked as spam.

elzody commented Jan 22, 2025

codewithvk commented Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

juliusknorr commented Jan 23, 2025

codewithvk commented Jan 24, 2025

codewithvk commented Jan 24, 2025

pedropintosilva commented Jan 24, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codewithvk commented Jan 23, 2025 •

edited

Loading

pedropintosilva commented Jan 24, 2025 •

edited

Loading