-
Notifications
You must be signed in to change notification settings - Fork 105
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New: Watermarking preferences (#721)
Add support for two new watermarking preferences: `previewWMPref` and `downloadWM`. `previewWMPref` allows configuration of the preview experience for watermarked files (do you see watermarked versions of the file or not) and `downloadWM` controls whether watermarked files or the original is downloaded via the download button and download() API. Also fixed some flaky tests.
- Loading branch information
Showing
15 changed files
with
672 additions
and
416 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| import { openUrlInsideIframe } from './util'; | ||
|
|
||
| const DEFAULT_DOWNLOAD_HOST_PREFIX = 'https://dl.'; | ||
| const PROD_CUSTOM_HOST_SUFFIX = 'boxcloud.com'; | ||
| const DOWNLOAD_NOTIFICATION_SHOWN_KEY = 'download_host_notification_shown'; | ||
| const DOWNLOAD_HOST_FALLBACK_KEY = 'download_host_fallback'; | ||
| const NUMBERED_HOST_PREFIX_REGEX = /^https:\/\/dl\d+\./; | ||
| const CUSTOM_HOST_PREFIX_REGEX = /^https:\/\/[A-Za-z0-9]+./; | ||
|
|
||
| class DownloadReachability { | ||
| /** | ||
| * Extracts the hostname from a URL | ||
| * | ||
| * @param {string} downloadUrl - Content download URL, may either be a template or an actual URL | ||
| * @return {string} The hoostname of the given URL | ||
| */ | ||
| static getHostnameFromUrl(downloadUrl) { | ||
| const contentHost = document.createElement('a'); | ||
| contentHost.href = downloadUrl; | ||
| return contentHost.hostname; | ||
| } | ||
|
|
||
| /** | ||
| * Checks if the url is a download host, but not the default download host. | ||
| * | ||
| * @public | ||
| * @param {string} downloadUrl - Content download URL, may either be a template or an actual URL | ||
| * @return {boolean} - HTTP response | ||
| */ | ||
| static isCustomDownloadHost(downloadUrl) { | ||
| // A custom download host either | ||
| // 1. begins with a numbered dl hostname | ||
| // 2. or starts with a custom prefix and ends with boxcloud.com | ||
| return ( | ||
| !downloadUrl.startsWith(DEFAULT_DOWNLOAD_HOST_PREFIX) && | ||
| (!!downloadUrl.match(NUMBERED_HOST_PREFIX_REGEX) || downloadUrl.indexOf(PROD_CUSTOM_HOST_SUFFIX) !== -1) | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Replaces the hostname of a download URL with the default hostname, https://dl. | ||
| * | ||
| * @public | ||
| * @param {string} downloadUrl - Content download URL, may either be a template or an actual URL | ||
| * @return {string} - The updated download URL | ||
| */ | ||
| static replaceDownloadHostWithDefault(downloadUrl) { | ||
| if (downloadUrl.match(NUMBERED_HOST_PREFIX_REGEX)) { | ||
| // First check to see if we can swap a numbered dl prefix for the default | ||
| return downloadUrl.replace(NUMBERED_HOST_PREFIX_REGEX, DEFAULT_DOWNLOAD_HOST_PREFIX); | ||
| } | ||
|
|
||
| // Otherwise replace the custom prefix with the default | ||
| return downloadUrl.replace(CUSTOM_HOST_PREFIX_REGEX, DEFAULT_DOWNLOAD_HOST_PREFIX); | ||
| } | ||
|
|
||
| /** | ||
| * Sets session storage to use the default download host. | ||
| * | ||
| * @public | ||
| * @return {void} | ||
| */ | ||
| static setDownloadHostFallback() { | ||
| sessionStorage.setItem(DOWNLOAD_HOST_FALLBACK_KEY, 'true'); | ||
| } | ||
|
|
||
| /** | ||
| * Checks if we have detected a blocked download host and have decided to fall back. | ||
| * | ||
| * @public | ||
| * @return {boolean} Whether the sessionStorage indicates that a download host has been blocked | ||
| */ | ||
| static isDownloadHostBlocked() { | ||
| return sessionStorage.getItem(DOWNLOAD_HOST_FALLBACK_KEY) === 'true'; | ||
| } | ||
|
|
||
| /** | ||
| * Stores the host in an array via localstorage so that we don't show a notification for it again | ||
| * | ||
| * @public | ||
| * @param {string} downloadHost - Download URL host name | ||
| * @return {void} | ||
| */ | ||
| static setDownloadHostNotificationShown(downloadHost) { | ||
| const shownHostsArr = JSON.parse(localStorage.getItem(DOWNLOAD_NOTIFICATION_SHOWN_KEY)) || []; | ||
| shownHostsArr.push(downloadHost); | ||
| localStorage.setItem(DOWNLOAD_NOTIFICATION_SHOWN_KEY, JSON.stringify(shownHostsArr)); | ||
| } | ||
|
|
||
| /** | ||
| * Determines what notification should be shown if needed. | ||
| * | ||
| * @public | ||
| * @param {string} downloadUrl - Content download URL | ||
| * @return {string|undefined} Which host should we show a notification for, if any | ||
| */ | ||
| static getDownloadNotificationToShow(downloadUrl) { | ||
| const contentHostname = DownloadReachability.getHostnameFromUrl(downloadUrl); | ||
| const shownHostsArr = JSON.parse(localStorage.getItem(DOWNLOAD_NOTIFICATION_SHOWN_KEY)) || []; | ||
|
|
||
| return sessionStorage.getItem(DOWNLOAD_HOST_FALLBACK_KEY) === 'true' && | ||
| !shownHostsArr.includes(contentHostname) && | ||
| DownloadReachability.isCustomDownloadHost(downloadUrl) | ||
| ? contentHostname | ||
| : undefined; | ||
| } | ||
|
|
||
| /** | ||
| * Checks if the provided host is reachable. If not set the session storage to reflect this. | ||
| * | ||
| * @param {string} downloadUrl - Content download URL, may either be a template or an actual URL | ||
| * @return {void} | ||
| */ | ||
| static setDownloadReachability(downloadUrl) { | ||
| return fetch(downloadUrl, { method: 'HEAD' }) | ||
| .then(() => { | ||
| return Promise.resolve(false); | ||
| }) | ||
| .catch(() => { | ||
| DownloadReachability.setDownloadHostFallback(); | ||
| return Promise.resolve(true); | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Downloads file with reachability checks. | ||
| * | ||
| * @param {string} downloadUrl - Content download URL | ||
| * @return {void} | ||
| */ | ||
| static downloadWithReachabilityCheck(downloadUrl) { | ||
| const defaultDownloadUrl = DownloadReachability.replaceDownloadHostWithDefault(downloadUrl); | ||
| if (DownloadReachability.isDownloadHostBlocked() || !DownloadReachability.isCustomDownloadHost(downloadUrl)) { | ||
| // If we know the host is blocked, or we are already using the default, | ||
| // use the default. | ||
| openUrlInsideIframe(defaultDownloadUrl); | ||
| } else { | ||
| // Try the custom host, then check reachability | ||
| openUrlInsideIframe(downloadUrl); | ||
| DownloadReachability.setDownloadReachability(downloadUrl).then((isBlocked) => { | ||
| if (isBlocked) { | ||
| // If download is unreachable, try again with default | ||
| openUrlInsideIframe(defaultDownloadUrl); | ||
| } | ||
| }); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| export default DownloadReachability; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.