Papermark is the open-source DocSend alternative and secure data rooms with built-in analytics and custom domains.
feat: add screen shield for discouraging screenshots
Marc Seitz8fb917c7f2bb
diff --git a/components/links/link-sheet/index.tsx b/components/links/link-sheet/index.tsxindex 6253a6d2..bc7c1aba 100644--- a/components/links/link-sheet/index.tsx+++ b/components/links/link-sheet/index.tsx@@ -71,6 +71,7 @@ export const DEFAULT_LINK_PROPS = (linkType: LinkType) => ({watermarkConfig: null,audienceType: LinkAudienceType.GENERAL,groupId: null,+ screenShieldPercentage: null,});export type DEFAULT_LINK_TYPE = {@@ -103,6 +104,7 @@ export type DEFAULT_LINK_TYPE = {watermarkConfig: WatermarkConfig | null;audienceType: LinkAudienceType;groupId: string | null;+ screenShieldPercentage: number | null;};export default function LinkSheet({diff --git a/components/links/link-sheet/link-options.tsx b/components/links/link-sheet/link-options.tsxindex bf2ba5d8..ea0f6a67 100644--- a/components/links/link-sheet/link-options.tsx+++ b/components/links/link-sheet/link-options.tsx@@ -21,6 +21,7 @@ import useLimits from "@/lib/swr/use-limits";import AgreementSection from "./agreement-section";import QuestionSection from "./question-section";+import ScreenShieldSection from "./screen-shield-section";import ScreenshotProtectionSection from "./screenshot-protection-section";import WatermarkSection from "./watermark-section";@@ -128,6 +129,11 @@ export const LinkOptions = ({}handleUpgradeStateChange={handleUpgradeStateChange}/>+ <ScreenShieldSection+ {...{ data, setData }}+ isAllowed={isTrial || isBusiness || isDatarooms}+ handleUpgradeStateChange={handleUpgradeStateChange}+ /><WatermarkSection{...{ data, setData }}isAllowed={isTrial || isDatarooms}diff --git a/components/links/link-sheet/screen-shield-section.tsx b/components/links/link-sheet/screen-shield-section.tsxnew file mode 100644index 00000000..165170ab--- /dev/null+++ b/components/links/link-sheet/screen-shield-section.tsx@@ -0,0 +1,92 @@+import { useEffect, useState } from "react";++import { Label } from "@/components/ui/label";+import {+ Select,+ SelectContent,+ SelectItem,+ SelectTrigger,+ SelectValue,+} from "@/components/ui/select";++import { DEFAULT_LINK_TYPE } from ".";+import LinkItem from "./link-item";+import { LinkUpgradeOptions } from "./link-options";++export default function ScreenShieldSection({+ data,+ setData,+ isAllowed,+ handleUpgradeStateChange,+}: {+ data: DEFAULT_LINK_TYPE;+ setData: React.Dispatch<React.SetStateAction<DEFAULT_LINK_TYPE>>;+ isAllowed: boolean;+ handleUpgradeStateChange: ({+ state,+ trigger,+ plan,+ }: LinkUpgradeOptions) => void;+}) {+ const { screenShieldPercentage } = data;+ const [enabled, setEnabled] = useState<boolean>(!!screenShieldPercentage);++ useEffect(() => {+ setEnabled(!!screenShieldPercentage);+ }, [screenShieldPercentage]);++ const handleEnableScreenShield = () => {+ const updatedEnabled = !enabled;+ setData({+ ...data,+ screenShieldPercentage: updatedEnabled ? 35 : null, // Default to 35% when enabling+ });+ setEnabled(updatedEnabled);+ };++ return (+ <div className="pb-5">+ <LinkItem+ title="Enable Screen Shield"+ tooltipContent="Add a draggable shield that limits the visible area of your content"+ enabled={enabled}+ action={handleEnableScreenShield}+ isAllowed={isAllowed}+ requiredPlan="business"+ upgradeAction={() =>+ handleUpgradeStateChange({+ state: true,+ trigger: "link_sheet_screen_shield_section",+ plan: "Business",+ })+ }+ />++ {enabled && (+ <div className="mt-4 space-y-3">+ <div className="space-y-2">+ <Label>Visible Area</Label>+ <Select+ value={String(screenShieldPercentage)}+ onValueChange={(value) =>+ setData({+ ...data,+ screenShieldPercentage: parseInt(value),+ })+ }+ >+ <SelectTrigger>+ <SelectValue />+ </SelectTrigger>+ <SelectContent>+ <SelectItem value="20">20% - Most Restrictive</SelectItem>+ <SelectItem value="35">35% - Recommended</SelectItem>+ <SelectItem value="50">50% - Most Permissive</SelectItem>+ </SelectContent>+ </Select>+ </div>+ </div>+ )}+ </div>+ );+}diff --git a/components/links/links-table.tsx b/components/links/links-table.tsxindex 91af9519..55ab92de 100644--- a/components/links/links-table.tsx+++ b/components/links/links-table.tsx@@ -111,6 +111,7 @@ export default function LinksTable({watermarkConfig: link.watermarkConfig as WatermarkConfig | null,audienceType: link.audienceType,groupId: link.groupId,+ screenShieldPercentage: link.screenShieldPercentage,});//wait for dropdown to close before opening the link sheetsetTimeout(() => {diff --git a/components/view/PagesViewerNew.tsx b/components/view/PagesViewerNew.tsxindex c63ccc69..31f50bbd 100644--- a/components/view/PagesViewerNew.tsx+++ b/components/view/PagesViewerNew.tsx@@ -27,6 +27,7 @@ import { TDocumentData } from "./dataroom/dataroom-view";import Nav from "./nav";import { PoweredBy } from "./powered-by";import Question from "./question";+import { ScreenShield } from "./screen-shield";import Toolbar from "./toolbar";import ViewDurationSummary from "./visitor-graph";import { SVGWatermark } from "./watermark-svg";@@ -76,6 +77,7 @@ export default function PagesViewer({allowDownload,feedbackEnabled,screenshotProtectionEnabled,+ screenShieldPercentage,versionNumber,brand,documentName,@@ -106,6 +108,7 @@ export default function PagesViewer({allowDownload: boolean;feedbackEnabled: boolean;screenshotProtectionEnabled: boolean;+ screenShieldPercentage: number | null;versionNumber: number;brand?: Partial<Brand> | Partial<DataroomBrand> | null;documentName?: string;@@ -493,7 +496,7 @@ export default function PagesViewer({// Function to handle context for screenshottingconst handleContextMenu = (event: React.MouseEvent<HTMLDivElement>) => {- if (!screenshotProtectionEnabled) {+ if (!screenshotProtectionEnabled && !screenShieldPercentage) {return null;}@@ -1084,6 +1087,9 @@ export default function PagesViewer({isPreview={isPreview}/>) : null}+ {!!screenShieldPercentage ? (+ <ScreenShield visiblePercentage={screenShieldPercentage} />+ ) : null}{screenshotProtectionEnabled ? <ScreenProtector /> : null}{showPoweredByBanner ? <PoweredBy linkId={linkId} /> : null}</div>diff --git a/components/view/dataroom/dataroom-view.tsx b/components/view/dataroom/dataroom-view.tsxindex 3f14b5d9..e8799fae 100644--- a/components/view/dataroom/dataroom-view.tsx+++ b/components/view/dataroom/dataroom-view.tsx@@ -395,6 +395,7 @@ export default function DataroomView({allowDownload={viewData.canDownload ?? link.allowDownload!}feedbackEnabled={link.enableFeedback!}screenshotProtectionEnabled={link.enableScreenshotProtection!}+ screenShieldPercentage={link.screenShieldPercentage}versionNumber={documentData.documentVersionNumber}brand={brand}dataroomId={dataroom.id}@@ -421,6 +422,7 @@ export default function DataroomView({allowDownload={viewData.canDownload ?? link.allowDownload!}feedbackEnabled={link.enableFeedback!}screenshotProtectionEnabled={link.enableScreenshotProtection!}+ screenShieldPercentage={link.screenShieldPercentage}versionNumber={documentData.documentVersionNumber}brand={brand}dataroomId={dataroom.id}diff --git a/components/view/powered-by.tsx b/components/view/powered-by.tsxindex 643e4802..2057be68 100644--- a/components/view/powered-by.tsx+++ b/components/view/powered-by.tsx@@ -2,14 +2,14 @@ import { createPortal } from "react-dom";export const PoweredBy = ({ linkId }: { linkId: string }) => {return createPortal(- <div className="absolute bottom-0 right-0 w-fit">+ <div className="absolute bottom-0 right-0 z-[100] w-fit"><div className="p-6"><div className="pointer-events-auto relative z-20 flex min-h-8 w-auto items-center justify-end whitespace-nowrap rounded-md bg-black text-white ring-1 ring-white/40 hover:ring-white/90"><ahref={`https://www.papermark.io?utm_campaign=poweredby&utm_medium=poweredby&utm_source=papermark-${linkId}`}target="_blank"rel="noopener noreferrer"- className="rounded-sm text-sm "+ className="rounded-sm text-sm"style={{ paddingInlineStart: "12px", paddingInlineEnd: "12px" }}>Share docs via{" "}diff --git a/components/view/screen-shield.tsx b/components/view/screen-shield.tsxnew file mode 100644index 00000000..52e7ffb4--- /dev/null+++ b/components/view/screen-shield.tsx@@ -0,0 +1,150 @@+"use client";++import { useCallback, useEffect, useState } from "react";++import { CircleHelpIcon } from "lucide-react";++import { ButtonTooltip } from "../ui/tooltip";++export function ScreenShield({+ visiblePercentage = 35,+}: {+ visiblePercentage?: number;+}) {+ const navbarHeight = 64;+ const minShieldHeight = 32;++ const navbarHeightVh = (navbarHeight / window.innerHeight) * 100;+ const minShieldHeightVh = (minShieldHeight / window.innerHeight) * 100;++ const availableHeight = 100 - navbarHeightVh;++ const [handlePosition, setHandlePosition] = useState(+ (availableHeight - visiblePercentage) / 2,+ );++ const [isDragging, setIsDragging] = useState(false);+ const [startY, setStartY] = useState(0);++ const handleMouseDown = (e: React.MouseEvent | React.TouchEvent) => {+ setIsDragging(true);+ setStartY("touches" in e ? e.touches[0].clientY : e.clientY);+ };++ const handleMove = useCallback(+ (clientY: number) => {+ if (!isDragging) return;++ const delta = clientY - startY;+ const viewportHeight = window.innerHeight;+ const deltaPercentage = (delta / viewportHeight) * 100;++ const newPosition = Math.min(+ availableHeight - visiblePercentage - minShieldHeightVh,+ Math.max(minShieldHeightVh, handlePosition + deltaPercentage),+ );++ setHandlePosition(newPosition);+ setStartY(clientY);+ },+ [isDragging, startY, handlePosition, availableHeight, visiblePercentage],+ );++ const handleMouseMove = useCallback(+ (e: MouseEvent) => {+ handleMove(e.clientY);+ },+ [handleMove],+ );++ const handleTouchMove = useCallback(+ (e: TouchEvent) => {+ handleMove(e.touches[0].clientY);+ },+ [handleMove],+ );++ const handleEnd = useCallback(() => {+ setIsDragging(false);+ }, []);++ useEffect(() => {+ if (isDragging) {+ window.addEventListener("mousemove", handleMouseMove);+ window.addEventListener("touchmove", handleTouchMove);+ window.addEventListener("mouseup", handleEnd);+ window.addEventListener("touchend", handleEnd);+ }++ return () => {+ window.removeEventListener("mousemove", handleMouseMove);+ window.removeEventListener("touchmove", handleTouchMove);+ window.removeEventListener("mouseup", handleEnd);+ window.removeEventListener("touchend", handleEnd);+ };+ }, [isDragging, handleMouseMove, handleTouchMove, handleEnd]);++ const patternBg = `url("data:image/svg+xml,%3Csvg width='60' height='60' viewBox='0 0 60 60' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M30 0l30 30-30 30L0 30 30 0zm0 10L10 30l20 20 20-20-20-20z' fill='%23ffffff' fill-opacity='0.1'/%3E%3C/svg%3E")`;++ console.log("total height", availableHeight);+ console.log("handle position", handlePosition);+ console.log("visible percentage", visiblePercentage);++ return (+ <>+ {/* Top Shield */}+ <div+ onMouseDown={handleMouseDown}+ onTouchStart={handleMouseDown}+ onContextMenu={(e) => e.preventDefault()}+ className="fixed inset-x-0 top-16 w-full origin-top cursor-move bg-black/90 backdrop-blur-sm transition-transform duration-300 ease-out"+ style={{+ height: `${handlePosition}svh`,+ backgroundImage: patternBg,+ backgroundSize: "30px 30px",+ }}+ >+ <div+ onMouseDown={handleMouseDown}+ onTouchStart={handleMouseDown}+ className="absolute inset-x-0 bottom-0 cursor-move bg-black/90 p-2 text-center text-white hover:bg-gray-500 hover:opacity-80"+ >+ <div className="flex items-center justify-center gap-2">+ <span className="select-none text-xs font-medium">+ PRIVATE AND CONFIDENTIAL+ </span>+ <ButtonTooltip+ content="The sender has reduced the viewing area to protect the contents of this confidential file. Click and drag this bar to adjust your view."+ sideOffset={16}+ >+ <CircleHelpIcon className="h-4 w-4" />+ </ButtonTooltip>+ </div>+ </div>+ </div>++ {/* Bottom Shield */}+ <div+ onMouseDown={handleMouseDown}+ onTouchStart={handleMouseDown}+ onContextMenu={(e) => e.preventDefault()}+ className="fixed inset-x-0 bottom-0 w-full origin-bottom cursor-move bg-black/90 backdrop-blur-sm transition-transform duration-300 ease-out"+ style={{+ height: `${availableHeight - visiblePercentage - handlePosition}svh`,+ backgroundImage: patternBg,+ backgroundSize: "30px 30px",+ }}+ >+ <div+ onMouseDown={handleMouseDown}+ onTouchStart={handleMouseDown}+ className="absolute inset-x-0 top-0 cursor-move bg-black/90 p-2 text-center text-white hover:bg-gray-500 hover:opacity-80"+ >+ <div className="select-none text-xs">+ <span>Drag to adjust view</span>+ </div>+ </div>+ </div>+ </>+ );+}diff --git a/components/view/view-data.tsx b/components/view/view-data.tsxindex b6d8b2be..c9ce967c 100644--- a/components/view/view-data.tsx+++ b/components/view/view-data.tsx@@ -92,6 +92,7 @@ export default function ViewData({allowDownload={link.allowDownload!}feedbackEnabled={link.enableFeedback!}screenshotProtectionEnabled={link.enableScreenshotProtection!}+ screenShieldPercentage={link.screenShieldPercentage}versionNumber={document.versions[0].versionNumber}brand={brand}showPoweredByBanner={showPoweredByBanner}@@ -118,6 +119,7 @@ export default function ViewData({allowDownload={link.allowDownload!}feedbackEnabled={link.enableFeedback!}screenshotProtectionEnabled={link.enableScreenshotProtection!}+ screenShieldPercentage={link.screenShieldPercentage}versionNumber={document.versions[0].versionNumber}brand={brand}showPoweredByBanner={showPoweredByBanner}diff --git a/components/view/viewer/image-viewer.tsx b/components/view/viewer/image-viewer.tsxindex 5534c104..6c18863f 100644--- a/components/view/viewer/image-viewer.tsx+++ b/components/view/viewer/image-viewer.tsx@@ -19,6 +19,7 @@ import { ScreenProtector } from "../ScreenProtection";import { TDocumentData } from "../dataroom/dataroom-view";import Nav from "../nav";import { PoweredBy } from "../powered-by";+import { ScreenShield } from "../screen-shield";import { SVGWatermark } from "../watermark-svg";const trackPageView = async (data: {@@ -52,6 +53,7 @@ export default function ImageViewer({allowDownload,feedbackEnabled,screenshotProtectionEnabled,+ screenShieldPercentage,versionNumber,brand,documentName,@@ -76,6 +78,7 @@ export default function ImageViewer({allowDownload: boolean;feedbackEnabled: boolean;screenshotProtectionEnabled: boolean;+ screenShieldPercentage: number | null;versionNumber: number;brand?: Partial<Brand> | Partial<DataroomBrand> | null;documentName?: string;@@ -252,7 +255,7 @@ export default function ImageViewer({// Function to handle context for screenshottingconst handleContextMenu = (event: React.MouseEvent<HTMLDivElement>) => {- if (!screenshotProtectionEnabled) {+ if (!screenshotProtectionEnabled && !screenShieldPercentage) {return null;}@@ -382,6 +385,9 @@ export default function ImageViewer({</div></div>+ {!!screenShieldPercentage ? (+ <ScreenShield visiblePercentage={screenShieldPercentage} />+ ) : null}{screenshotProtectionEnabled ? <ScreenProtector /> : null}{showPoweredByBanner ? <PoweredBy linkId={linkId} /> : null}</div>diff --git a/pages/api/links/[id]/index.ts b/pages/api/links/[id]/index.tsindex b5ced41d..1e20cbdb 100644--- a/pages/api/links/[id]/index.ts+++ b/pages/api/links/[id]/index.ts@@ -38,6 +38,7 @@ export default async function handle(allowDownload: true,enableFeedback: true,enableScreenshotProtection: true,+ screenShieldPercentage: true,password: true,isArchived: true,enableCustomMetatag: true,@@ -241,6 +242,7 @@ export default async function handle(enableNotification: linkData.enableNotification,enableFeedback: linkData.enableFeedback,enableScreenshotProtection: linkData.enableScreenshotProtection,+ screenShieldPercentage: linkData.screenShieldPercentage,enableCustomMetatag: linkData.enableCustomMetatag,metaTitle: linkData.metaTitle || null,metaDescription: linkData.metaDescription || null,diff --git a/pages/api/links/domains/[...domainSlug].ts b/pages/api/links/domains/[...domainSlug].tsindex 9fb9f377..a6715b30 100644--- a/pages/api/links/domains/[...domainSlug].ts+++ b/pages/api/links/domains/[...domainSlug].ts@@ -48,6 +48,7 @@ export default async function handle(enableCustomMetatag: true,enableFeedback: true,enableScreenshotProtection: true,+ screenShieldPercentage: true,metaTitle: true,metaDescription: true,metaImage: true,diff --git a/pages/api/links/index.ts b/pages/api/links/index.tsindex 12c6f4bd..499c510d 100644--- a/pages/api/links/index.ts+++ b/pages/api/links/index.ts@@ -132,6 +132,7 @@ export default async function handler(enableNotification: linkData.enableNotification,enableFeedback: linkData.enableFeedback,enableScreenshotProtection: linkData.enableScreenshotProtection,+ screenShieldPercentage: linkData.screenShieldPercentage,enableCustomMetatag: linkData.enableCustomMetatag,metaTitle: linkData.metaTitle || null,metaDescription: linkData.metaDescription || null,diff --git a/prisma/migrations/20241126000000_add_screen_shield/migration.sql b/prisma/migrations/20241126000000_add_screen_shield/migration.sqlnew file mode 100644index 00000000..f772ea49--- /dev/null+++ b/prisma/migrations/20241126000000_add_screen_shield/migration.sql@@ -0,0 +1,3 @@+-- AlterTable+ALTER TABLE "Link" ADD COLUMN "screenShieldPercentage" INTEGER;+diff --git a/prisma/schema.prisma b/prisma/schema.prismaindex 6ae2fcc4..149be35f 100644--- a/prisma/schema.prisma+++ b/prisma/schema.prisma@@ -251,6 +251,7 @@ model Link {enableFeedback Boolean? @default(false) // Optional give user a option to enable the reactions toolbarenableQuestion Boolean? @default(false) // Optional give user a option to enable the question feedbackenableScreenshotProtection Boolean? @default(false) // Optional give user a option to enable the screenshot protection+ screenShieldPercentage Int? // Optional give user a option to enable the screen shield percentagefeedback Feedback?enableAgreement Boolean? @default(false) // Optional give user a option to enable the terms and conditionsagreement Agreement? @relation(fields: [agreementId], references: [id], onDelete: SetNull)