Make read more in contextual helpers configurable (owncloud#8713)

lemanschik · Mar 27, 2023 · 9c8650e · 9c8650e
1 parent 2582f8d
commit 9c8650e
Show file tree

Hide file tree

Showing 12 changed files with 89 additions and 48 deletions.
diff --git a/changelog/unreleased/enhancement-context-helper-read-more-configurable b/changelog/unreleased/enhancement-context-helper-read-more-configurable
@@ -0,0 +1,6 @@
+Enhancement: Context helper read more link configurable
+
+We've added a configuration variable to disable the read more link in the contextual helper.
+
+https://github.com/owncloud/web/pull/8713
+https://github.com/owncloud/web/issues/8570
diff --git a/config/config.json.sample-ocis b/config/config.json.sample-ocis
@@ -32,6 +32,7 @@
       "xhr": {
         "timeout": 60000
       }
-    }
+    },
+    "contextHelpersReadMore": true
   }
 }
diff --git a/config/vite_ocis/config.json b/config/vite_ocis/config.json
@@ -18,7 +18,8 @@
       "image/tiff",
       "image/bmp",
       "image/x-ms-bmp"
-    ]
+    ],
+    "contextHelpersReadMore": true
   },
   "external_apps": [
     {

diff --git a/dev/docker/ocis.web.config.json b/dev/docker/ocis.web.config.json
@@ -25,7 +25,8 @@
       "image/tiff",
       "image/bmp",
       "image/x-ms-bmp"
-    ]
+    ],
+    "contextHelpersReadMore": true
   },
   "apps": ["files", "text-editor", "pdf-viewer", "search", "external", "admin-settings"],
   "external_apps": [

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -68,6 +68,7 @@ hovers the row with his mouse. Defaults to `false`.
 - `options.upload.xhr.timeout` Specifies the timeout for XHR uploads in milliseconds.
 - `options.editor.autosaveEnabled` Specifies if the autosave for the editor apps is enabled.
 - `options.editor.autosaveInterval` Specifies the time interval for the autosave of editor apps in seconds.
+- `options.editor.contextHelpersReadMore` Specifies whether the "Read more" link should be displayed or not.
 
 ### Sentry
 

diff --git a/packages/web-app-files/src/components/SideBar/Shares/FileLinks.vue b/packages/web-app-files/src/components/SideBar/Shares/FileLinks.vue
@@ -130,6 +130,7 @@ import { getLocaleFromLanguage } from 'web-pkg/src/helpers'
 import { Resource } from 'web-client/src/helpers'
 import { isLocationSharesActive } from '../../../router'
 import { useShares } from 'web-app-files/src/composables'
+import { configurationManager } from 'web-pkg'
 
 export default defineComponent({
   name: 'FileLinks',
@@ -178,7 +179,8 @@ export default defineComponent({
       outgoingLinks,
       directLinks,
       indirectLinks,
-      canCreatePublicLinks
+      canCreatePublicLinks,
+      configurationManager
     }
   },
   computed: {
@@ -251,10 +253,10 @@ export default defineComponent({
     },
 
     viaLinkHelp() {
-      return shareViaLinkHelp
+      return shareViaLinkHelp(this.configurationManager)
     },
     indirectLinkHelp() {
-      return shareViaIndirectLinkHelp
+      return shareViaIndirectLinkHelp(this.configurationManager)
     },
 
     canCreateLinks() {

diff --git a/packages/web-app-files/src/components/SideBar/Shares/FileShares.vue b/packages/web-app-files/src/components/SideBar/Shares/FileShares.vue
@@ -87,6 +87,7 @@ import { isProjectSpaceResource, Resource } from 'web-client/src/helpers'
 import { getSharedAncestorRoute } from 'web-app-files/src/helpers/share'
 import { AncestorMetaData } from 'web-app-files/src/helpers/resource/ancestorMetaData'
 import { useShares } from 'web-app-files/src/composables'
+import { configurationManager } from 'web-pkg'
 
 export default defineComponent({
   name: 'FileShares',
@@ -137,7 +138,8 @@ export default defineComponent({
       hasProjectSpaces: useCapabilityProjectSpacesEnabled(),
       hasShareJail: useCapabilityShareJailEnabled(),
       hasResharing: useCapabilityFilesSharingResharing(),
-      getSharedAncestor
+      getSharedAncestor,
+      configurationManager
     }
   },
   computed: {
@@ -149,15 +151,15 @@ export default defineComponent({
       const cernFeatures = !!this.configuration?.options?.cernFeatures
 
       if (cernFeatures) {
-        const mergedHelp = shareInviteCollaboratorHelp
+        const mergedHelp = shareInviteCollaboratorHelp(this.configurationManager)
         mergedHelp.list = [
           ...shareInviteCollaboratorHelpCern.list,
-          ...shareInviteCollaboratorHelp.list
+          ...shareInviteCollaboratorHelp(this.configurationManager).list
         ]
         return mergedHelp
       }
 
-      return shareInviteCollaboratorHelp
+      return shareInviteCollaboratorHelp(this.configurationManager)
     },
     helpersEnabled() {
       return this.configuration?.options?.contextHelpers

diff --git a/packages/web-app-files/src/components/SideBar/Shares/SpaceMembers.vue b/packages/web-app-files/src/components/SideBar/Shares/SpaceMembers.vue
@@ -73,6 +73,7 @@ import { Resource } from 'web-client/src/helpers'
 import { useClientService } from 'web-pkg/src/composables'
 import Fuse from 'fuse.js'
 import Mark from 'mark.js'
+import { configurationManager } from 'web-pkg'
 
 export default defineComponent({
   name: 'SpaceMembers',
@@ -91,7 +92,8 @@ export default defineComponent({
     return {
       filterTerm: '',
       isFilterOpen: false,
-      markInstance: null
+      markInstance: null,
+      configurationManager
     }
   },
   computed: {
@@ -106,7 +108,7 @@ export default defineComponent({
       return this.configuration?.options?.contextHelpers
     },
     spaceAddMemberHelp() {
-      return shareSpaceAddMemberHelp
+      return shareSpaceAddMemberHelp(this.configurationManager)
     },
     hasCollaborators() {
       return this.spaceMembers.length > 0

diff --git a/packages/web-app-files/src/helpers/contextualHelpers.ts b/packages/web-app-files/src/helpers/contextualHelpers.ts
@@ -1,3 +1,5 @@
+import { ConfigurationManager } from 'web-pkg'
+
 // just a dummy function to trick gettext tools
 function $gettext(msg) {
   return msg
@@ -6,33 +8,40 @@ export const empty = {
   text: '',
   list: ['', '', '']
 }
-export const shareInviteCollaboratorHelp = {
-  title: $gettext('Invite specific people'),
-  text: $gettext('Enter a name or group to share this item.'),
-  list: [
-    { text: $gettext('Subfolders'), headline: true },
-    {
-      text: $gettext(
-        'If you share a folder, all of its contents and subfolders will be shared as well.'
-      )
-    },
-    { text: $gettext('Notification'), headline: true },
-    {
-      text: $gettext('Invited people will be notified via email or in-app notification.')
-    },
-    { text: $gettext('Incognito'), headline: true },
-    {
-      text: $gettext('Invited people can not see who else has access..')
-    },
-    { text: $gettext('“via folder”'), headline: true },
-    {
-      text: $gettext(
-        'The “via folder” is shown next to a share, if access has already been given via a parent folder. Click on the “via folder” to edit the share on its parent folder.'
-      )
-    }
-  ],
-  readMoreLink: 'https://doc.owncloud.com/webui/next/owncloud_web/web_for_users.html#sharing'
+export const shareInviteCollaboratorHelp = (configurationManager: ConfigurationManager) => {
+  console.log(configurationManager.options)
+  return {
+    title: $gettext('Invite specific people'),
+    text: $gettext('Enter a name or group to share this item.'),
+    list: [
+      { text: $gettext('Subfolders'), headline: true },
+      {
+        text: $gettext(
+          'If you share a folder, all of its contents and subfolders will be shared as well.'
+        )
+      },
+      { text: $gettext('Notification'), headline: true },
+      {
+        text: $gettext('Invited people will be notified via email or in-app notification.')
+      },
+      { text: $gettext('Incognito'), headline: true },
+      {
+        text: $gettext('Invited people can not see who else has access..')
+      },
+      { text: $gettext('“via folder”'), headline: true },
+      {
+        text: $gettext(
+          'The “via folder” is shown next to a share, if access has already been given via a parent folder. Click on the “via folder” to edit the share on its parent folder.'
+        )
+      }
+    ],
+    readMoreLink:
+      configurationManager.options.contextHelpersReadMore === false
+        ? ''
+        : 'https://doc.owncloud.com/webui/next/owncloud_web/web_for_users.html#sharing'
+  }
 }
+
 export const shareInviteCollaboratorHelpCern = {
   list: [
     { text: $gettext('Search for service or secondary Account'), headline: true },
@@ -43,7 +52,7 @@ export const shareInviteCollaboratorHelpCern = {
     }
   ]
 }
-export const shareSpaceAddMemberHelp = {
+export const shareSpaceAddMemberHelp = (configurationManager: ConfigurationManager) => ({
   title: $gettext('Add members to this Space'),
   text: $gettext('Enter a name to add people or groups as members to this Space.'),
   list: [
@@ -60,9 +69,12 @@ export const shareSpaceAddMemberHelp = {
       )
     }
   ],
-  readMoreLink: 'https://doc.owncloud.com/webui/next/owncloud_web/web_for_users.html#sharing'
-}
-export const shareViaLinkHelp = {
+  readMoreLink:
+    configurationManager.options.contextHelpersReadMore === false
+      ? ''
+      : 'https://doc.owncloud.com/webui/next/owncloud_web/web_for_users.html#sharing'
+})
+export const shareViaLinkHelp = (configurationManager: ConfigurationManager) => ({
   title: $gettext('Choose how access is granted'),
   list: [
     {
@@ -93,9 +105,12 @@ export const shareViaLinkHelp = {
       )
     }
   ],
-  readMoreLink: 'https://doc.owncloud.com/webui/next/owncloud_web/web_for_users.html#sharing'
-}
-export const shareViaIndirectLinkHelp = {
+  readMoreLink:
+    configurationManager.options.contextHelpersReadMore === false
+      ? ''
+      : 'https://doc.owncloud.com/webui/next/owncloud_web/web_for_users.html#sharing'
+})
+export const shareViaIndirectLinkHelp = (configurationManager: ConfigurationManager) => ({
   title: $gettext('What are indirect links?'),
   text: $gettext('Indirect links are links giving access by a parent folder.'),
   list: [
@@ -109,5 +124,8 @@ export const shareViaIndirectLinkHelp = {
       )
     }
   ],
-  readMoreLink: 'https://doc.owncloud.com/webui/next/owncloud_web/web_for_users.html#sharing'
-}
+  readMoreLink:
+    configurationManager.options.contextHelpersReadMore === false
+      ? ''
+      : 'https://doc.owncloud.com/webui/next/owncloud_web/web_for_users.html#sharing'
+})
diff --git a/packages/web-pkg/src/configuration/manager.ts b/packages/web-pkg/src/configuration/manager.ts
@@ -74,6 +74,11 @@ export class ConfigurationManager {
 
   set options(options: OptionsConfiguration) {
     set(this.optionsConfiguration, 'routing.idBased', get(options, 'routing.idBased', true))
+    set(
+      this.optionsConfiguration,
+      'contextHelpersReadMore',
+      get(options, 'contextHelpersReadMore', true)
+    )
   }
 
   get options(): OptionsConfiguration {

diff --git a/packages/web-pkg/src/configuration/types.ts b/packages/web-pkg/src/configuration/types.ts
@@ -9,6 +9,7 @@ export interface RoutingOptionsConfiguration {
 export interface OptionsConfiguration {
   routing?: RoutingOptionsConfiguration
   logoutUrl?: string
+  contextHelpersReadMore?: boolean
 }
 
 export interface OAuth2Configuration {

diff --git a/packages/web-runtime/src/store/config.ts b/packages/web-runtime/src/store/config.ts
@@ -57,7 +57,8 @@ const state = {
     previewFileMimeTypes: [],
     runningOnEos: false,
     cernFeatures: false,
-    sharingRecipientsPerPage: 200
+    sharingRecipientsPerPage: 200,
+    contextHelpersReadMore: true
   }
 }