Merge pull request #4725 from dpalou/MOBILE-4925

MOBILE-4925 core: Use referer fix script if available

Author: crazyserver

src/core/classes/sites/site.ts

@@ -681,8 +681,8 @@ export class CoreSite extends CoreAuthenticatedSite {
             return url;
         }
 
-        if (CoreUrl.isTokenPluginFileUrl(url)) {
-            // Tokenpluginfile URLs authenticate the user using the access key, no need to use auto-login.
+        if (CoreUrl.isTokenPluginFileUrl(url) || CoreUrl.isRefererScriptUrl(url, this.siteUrl)) {
+            // URL doesn't need login or it already has a different login system.
             return url;
         }
 
@@ -901,14 +901,18 @@ export class CoreSite extends CoreAuthenticatedSite {
     }
 
     /**
-     * Given a URL, if it requires a referer, fix it to use a redirect script that will add the referer.
+     * Given a URL, fix it to use a redirect script that will add the referer if possible.
      *
      * @param url URL to fix.
      * @returns Fixed URL or original URL if no need to fix it.
      */
     fixRefererForUrl(url: string): string {
-        // @todo: This function will be implemented in MOBILE-4924 once this functionality is supported in Moodle LMS.
-        return url;
+        if (!this.isVersionGreaterEqualThan('5.2')) {
+            // The referer script was added in Moodle 5.2. If the site is older, referer cannot be fixed.
+            return url;
+        }
+
+        return CoreUrl.toRefererScriptUrl(url, this.siteUrl);
     }
 
 }

src/core/components/iframe/iframe.ts

@@ -76,6 +76,7 @@ export class CoreIframeComponent implements OnChanges, OnDestroy {
     @Input({ transform: toBoolean }) showFullscreenOnToolbar = false;
     @Input({ transform: toBoolean }) autoFullscreenOnRotate = false;
     @Input({ transform: toBoolean }) allowAutoLogin = true;
+    @Input({ transform: toBoolean }) addSiteReferer = false;
     @Output() loaded = new EventEmitter<HTMLIFrameElement>();
 
     loading?: boolean;
@@ -271,7 +272,7 @@ export class CoreIframeComponent implements OnChanges, OnDestroy {
                 url = CoreUrl.addParamsToUrl(autoLoginUrl, { lang }, {
                     checkAutoLoginUrl: autoLoginUrl !== url,
                 });
-            } else {
+            } else if (this.addSiteReferer || CoreUrl.urlNeedsReferer(url)) {
                 url = currentSite?.fixRefererForUrl(url) || url;
             }
 

src/core/constants.ts

@@ -194,6 +194,8 @@ export const DATA_APP_ALT_URL_TYPE = 'data-app-alt-url-type';
 export const DATASET_APP_ALT_URL_TYPE = 'appAltUrlType';
 export const DATA_APP_ALT_URL_LABEL = 'data-app-alt-url-label';
 export const DATASET_APP_ALT_URL_LABEL = 'appAltUrlLabel';
+export const DATA_APP_SITE_REFERER = 'data-app-site-referer';
+export const DATASET_APP_SITE_REFERER = 'appSiteReferer';
 
 /** @deprecated since 5.2. Use DATA_APP_OPEN_IN instead. */
 export const DATA_APP_OPEN_IN_LEGACY = 'data-open-in';

src/core/directives/format-text.ts

@@ -66,6 +66,7 @@ import {
     DATASET_APP_ALT_URL_TYPE,
     DATASET_APP_OPEN_IN,
     DATASET_APP_OPEN_IN_LEGACY,
+    DATASET_APP_SITE_REFERER,
     DATASET_APP_URL,
     DATASET_APP_URL_CONFIRM,
     DATASET_APP_URL_RESUME_ACTION,
@@ -1049,7 +1050,7 @@ export class CoreFormatTextDirective implements OnDestroy, AsyncDirective {
             CoreIframe.treatFrame(iframe, false);
 
             return;
-        } else if (site) {
+        } else if (site && (iframe.dataset[DATASET_APP_SITE_REFERER] === 'true' || CoreUrl.urlNeedsReferer(src))) {
             src = site.fixRefererForUrl(src);
         }
 

src/core/static/tests/url.test.ts

@@ -355,4 +355,21 @@ describe('CoreUrl', () => {
         expect(CoreUrl.getPluginFileArgs('http://mysite.com/pluginfile.php/6/')).toEqual(undefined);
     });
 
+    it('converts to referer script URL', () => {
+        const siteUrl = 'https://mysite.com';
+        expect(CoreUrl.toRefererScriptUrl('https://myvideoplayer.com/videoid', siteUrl)).toEqual(
+            `${siteUrl}/admin/tool/mobile/referer.php?url=https%3A%2F%2Fmyvideoplayer.com%2Fvideoid`,
+        );
+        expect(CoreUrl.toRefererScriptUrl('https://foo.bar', siteUrl)).toEqual(
+            `${siteUrl}/admin/tool/mobile/referer.php?url=https%3A%2F%2Ffoo.bar`,
+        );
+    });
+
+    it('checks if a URL is a referer script URL', () => {
+        const siteUrl = 'https://mysite.com';
+        expect(CoreUrl.isRefererScriptUrl(`${siteUrl}/admin/tool/mobile/referer.php`, siteUrl)).toBe(true);
+        expect(CoreUrl.isRefererScriptUrl(`${siteUrl}/admin/tool/mobile/refererr.php`, siteUrl)).toBe(false);
+        expect(CoreUrl.isRefererScriptUrl(`${siteUrl}/myplugin/admin/tool/mobile/referer.php`, siteUrl)).toBe(false);
+    });
+
 });

src/core/static/url.ts

@@ -1085,6 +1085,38 @@ export class CoreUrl {
         return url;
     }
 
+    /**
+     * Check whether a URL needs (or could need) a referer to work.
+     *
+     * @param url URL to check.
+     * @returns Whether the URL needs a referer.
+     */
+    static urlNeedsReferer(url: string): boolean {
+        return CoreUrl.isYoutubeURL(url) || CoreUrl.isVimeoVideoUrl(url);
+    }
+
+    /**
+     * Get the URL to use to view a URL adding a site referer.
+     *
+     * @param url URL to treat.
+     * @param siteUrl The URL of the site to use for the referer.
+     * @returns URL to use to add a referer.
+     */
+    static toRefererScriptUrl(url: string, siteUrl: string): string {
+        return CorePath.concatenatePaths(siteUrl, 'admin/tool/mobile/referer.php') + '?url=' + encodeURIComponent(url);
+    }
+
+    /**
+     * Check if a URL is a referer script URL.
+     *
+     * @param url URL to check.
+     * @param siteUrl The URL of the site to use for the referer.
+     * @returns Whether the URL is a referer script URL.
+     */
+    static isRefererScriptUrl(url: string, siteUrl: string): boolean {
+        return url.startsWith(CorePath.concatenatePaths(siteUrl, 'admin/tool/mobile/referer.php'));
+    }
+
 }
 
 export type CoreUrlParams = { [key: string]: string };