From 881fc915a006fa6838d01d916d97ee4f7faaf6e7 Mon Sep 17 00:00:00 2001
From: Richard Tibbles <richard@learningequality.org>
Date: Mon, 25 Nov 2024 13:11:17 -0800
Subject: [PATCH] Re-implement share file functionality. Remove unneeded
 appCapabilities from kolibri/utils.

---
 .../views/CurrentlyViewedResourceMetadata.vue | 42 +++++++++++++++++--
 .../assets/src/views/commonLearnStrings.js    |  4 ++
 kolibri/plugins/learn/kolibri_plugin.py       |  2 +
 packages/kolibri-tools/lib/moduleMapping.js   |  2 +-
 packages/kolibri/internal/apiSpec.js          |  1 -
 packages/kolibri/package.json                 |  1 -
 packages/kolibri/utils/appCapabilities.js     | 36 ----------------
 7 files changed, 46 insertions(+), 42 deletions(-)
 delete mode 100644 packages/kolibri/utils/appCapabilities.js

diff --git a/kolibri/plugins/learn/assets/src/views/CurrentlyViewedResourceMetadata.vue b/kolibri/plugins/learn/assets/src/views/CurrentlyViewedResourceMetadata.vue
index dc64e7fe757..492a8ab6de9 100644
--- a/kolibri/plugins/learn/assets/src/views/CurrentlyViewedResourceMetadata.vue
+++ b/kolibri/plugins/learn/assets/src/views/CurrentlyViewedResourceMetadata.vue
@@ -136,6 +136,12 @@
       class="download-button"
       data-test="download-button"
     />
+    <KButton
+      v-if="canShareFile"
+      :text="learnString('shareFile')"
+      class="share-button"
+      @click="shareFile()"
+    />
   </section>
 
 </template>
@@ -143,9 +149,12 @@
 
 <script>
 
-  import { ContentLevels } from 'kolibri/constants';
+  import { ContentNodeKinds, ContentLevels } from 'kolibri/constants';
   import camelCase from 'lodash/camelCase';
-
+  import client from 'kolibri/client';
+  import useUser from 'kolibri/composables/useUser';
+  import urls from 'kolibri/urls';
+  import pluginData from 'kolibri-plugin-data';
   import LearnerNeeds from 'kolibri-constants/labels/Needs';
   import DownloadButton from 'kolibri-common/components/DownloadButton';
   import TimeDuration from 'kolibri-common/components/TimeDuration';
@@ -167,6 +176,10 @@
       TimeDuration,
     },
     mixins: [commonCoreStrings, commonLearnStrings],
+    setup() {
+      const { isAppContext } = useUser();
+      return { isAppContext };
+    },
     props: {
       canDownloadExternally: {
         type: Boolean,
@@ -187,6 +200,13 @@
       };
     },
     computed: {
+      canShareFile() {
+        return (
+          this.isAppContext &&
+          this.content.kind !== ContentNodeKinds.EXERCISE &&
+          pluginData.canShareFile
+        );
+      },
       forBeginners() {
         return get(this.content, 'learner_needs', []).includes(LearnerNeeds.FOR_BEGINNERS);
       },
@@ -260,6 +280,21 @@
           return '-';
         }
       },
+      shareFile() {
+        const urlFunction = urls['kolibri:core:sharefile'];
+        return client({
+          url: urlFunction(),
+          method: 'POST',
+          data: {
+            content_node: this.content.id,
+            message: this.learnString('shareFileMessage', {
+              title: this.content.title,
+              topic: this.content.ancestors.slice(-1)[0].title,
+              copyrightHolder: this.content.license_owner,
+            }),
+          },
+        });
+      },
     },
   };
 
@@ -309,7 +344,8 @@
     padding-top: 8px;
   }
 
-  .download-button {
+  .download-button,
+  .share-button {
     margin-top: 16px;
   }
 
diff --git a/kolibri/plugins/learn/assets/src/views/commonLearnStrings.js b/kolibri/plugins/learn/assets/src/views/commonLearnStrings.js
index d3b9b40fc29..072ebdd7f24 100644
--- a/kolibri/plugins/learn/assets/src/views/commonLearnStrings.js
+++ b/kolibri/plugins/learn/assets/src/views/commonLearnStrings.js
@@ -106,6 +106,10 @@ export const learnStrings = createTranslator('CommonLearnStrings', {
     message: 'Share',
     context: 'Option to share a specific file from a learning resource.',
   },
+  shareFileMessage: {
+    message: '"{title}" (in "{topic}"), from {copyrightHolder}',
+    context: 'Message shared with the default file from a learning resource.',
+  },
   locationsInChannel: {
     message: 'Location in {channelname}',
     context:
diff --git a/kolibri/plugins/learn/kolibri_plugin.py b/kolibri/plugins/learn/kolibri_plugin.py
index 90ceeb3b2fb..d9681e29a94 100644
--- a/kolibri/plugins/learn/kolibri_plugin.py
+++ b/kolibri/plugins/learn/kolibri_plugin.py
@@ -3,6 +3,7 @@
 from kolibri.core.auth.constants.user_kinds import ANONYMOUS
 from kolibri.core.auth.constants.user_kinds import LEARNER
 from kolibri.core.content.hooks import ContentNodeDisplayHook
+from kolibri.core.content.hooks import ShareFileHook
 from kolibri.core.device.hooks import CheckIsMeteredHook
 from kolibri.core.device.utils import allow_learner_unassigned_resource_access
 from kolibri.core.device.utils import get_device_setting
@@ -65,6 +66,7 @@ def plugin_data(self):
                 "allow_download_on_metered_connection"
             ),
             "canCheckMeteredConnection": CheckIsMeteredHook.is_registered,
+            "canShareFile": ShareFileHook.is_registered,
             "allowGuestAccess": get_device_setting("allow_guest_access"),
             "allowLearnerDownloads": get_device_setting(
                 "allow_learner_download_resources"
diff --git a/packages/kolibri-tools/lib/moduleMapping.js b/packages/kolibri-tools/lib/moduleMapping.js
index d93e7d7a33b..ed08e7cdaec 100644
--- a/packages/kolibri-tools/lib/moduleMapping.js
+++ b/packages/kolibri-tools/lib/moduleMapping.js
@@ -150,7 +150,7 @@ module.exports = {
   },
   'kolibri.themeConfig': 'kolibri/styles/themeConfig',
   'kolibri.urls': 'kolibri/urls',
-  'kolibri.utils.appCapabilities': 'kolibri/utils/appCapabilities',
+  'kolibri.utils.appCapabilities': null, // Redistributed into more specific code where used.
   'kolibri.utils.browserInfo': 'kolibri/utils/browserInfo',
   'kolibri.utils.bytesForHumans': 'kolibri/uiText/bytesForHumans',
   'kolibri.utils.CatchErrors': 'kolibri/utils/CatchErrors',
diff --git a/packages/kolibri/internal/apiSpec.js b/packages/kolibri/internal/apiSpec.js
index 8afaeba9634..2a4f54805bb 100644
--- a/packages/kolibri/internal/apiSpec.js
+++ b/packages/kolibri/internal/apiSpec.js
@@ -38,7 +38,6 @@ export default {
   'kolibri/uiText/notificationStrings': require('kolibri/uiText/notificationStrings'),
   'kolibri/urls': require('kolibri/urls'),
   'kolibri/utils/CatchErrors': require('kolibri/utils/CatchErrors'),
-  'kolibri/utils/appCapabilities': require('kolibri/utils/appCapabilities'),
   'kolibri/utils/baseClient': require('kolibri/utils/baseClient'),
   'kolibri/utils/browserInfo': require('kolibri/utils/browserInfo'),
   'kolibri/utils/i18n': require('kolibri/utils/i18n'),
diff --git a/packages/kolibri/package.json b/packages/kolibri/package.json
index 104c708f2c4..67cfbdb4c53 100644
--- a/packages/kolibri/package.json
+++ b/packages/kolibri/package.json
@@ -41,7 +41,6 @@
     "./uiText/notificationStrings": "./uiText/notificationStrings",
     "./urls": "./urls",
     "./utils/CatchErrors": "./utils/CatchErrors",
-    "./utils/appCapabilities": "./utils/appCapabilities",
     "./utils/baseClient": "./utils/baseClient",
     "./utils/browserInfo": "./utils/browserInfo",
     "./utils/i18n": "./utils/i18n",
diff --git a/packages/kolibri/utils/appCapabilities.js b/packages/kolibri/utils/appCapabilities.js
deleted file mode 100644
index 363b65e0f82..00000000000
--- a/packages/kolibri/utils/appCapabilities.js
+++ /dev/null
@@ -1,36 +0,0 @@
-import client from 'kolibri/client';
-import logger from 'kolibri-logging';
-import urls from 'kolibri/urls';
-
-const logging = logger.getLogger(__filename);
-
-// Use a janky getter to return a method here to only expose functions
-// that are available so that we have a single API for both existence
-// checks and exposing the functions.
-
-export default {
-  /**
-   * @returns fn -> Promise<{ value: (boolean | null) }>
-   * Returns a function that returns a Promise that resolves to something responding to
-   * `data.value` whether it succeeds or fails.
-   */
-  get shareFile() {
-    // Deliberately using an options object here for the function signature,
-    // rather than positional arguments, so that we can evolve the API but
-    // maintain backwards compatibility.
-    // It would be more elegant to use a proxy for this, but that would require
-    // adding a polyfill for this specific usage, so this works just as well.
-    return ({ content_node, message }) => {
-      const urlFunction = urls['kolibri:core:sharefile'];
-      if (!urlFunction) {
-        logging.warn('Sharing a file is not supported on this platform');
-        return Promise.reject();
-      }
-      return client({
-        url: urlFunction(),
-        method: 'POST',
-        data: { content_node, message },
-      });
-    };
-  },
-};