Feature: Share links (#3996)

* Implement share links Basic implementation of share links Make certain share link fields not editable, automatically grant permissions on migrate Updated styling, error messages from expired / deleted links frontend code linting, reversable sharelink migration testing coverage Update translation strings No links message * Consolidate file response methods * improvements to share links on mobile devices * Refactor share links file_version * Add docs for share links * Apply suggestions from code review * When filtering share links, use the timezone aware now() * Removes extra call to setup directories for usage in testing * FIx copied badge display on some browsers * Move copy to ngx-clipboard library --------- Co-authored-by: Trenton H <797416+stumpylog@users.noreply.github.com>
2025-07-28 18:24:38 -05:00 · 2023-09-14 13:32:43 -07:00
parent 3a36d9b1ae
commit 7c9ab8c0b6
35 changed files with 1740 additions and 454 deletions
--- a/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.spec.ts
+++ b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.spec.ts
@@ -1,7 +1,6 @@
 import {
  ComponentFixture,
  TestBed,
-  discardPeriodicTasks,
  fakeAsync,
  tick,
 } from '@angular/core/testing'
--- a/src-ui/src/app/components/common/share-links-dropdown/share-links-dropdown.component.html
+++ b/src-ui/src/app/components/common/share-links-dropdown/share-links-dropdown.component.html
@@ -0,0 +1,61 @@
+<div ngbDropdown>
+    <button class="btn btn-sm btn-outline-primary me-2" id="shareLinksDropdown" [disabled]="disabled" ngbDropdownToggle>
+      <svg class="toolbaricon" fill="currentColor">
+        <use xlink:href="assets/bootstrap-icons.svg#link" />
+      </svg>
+      <div class="d-none d-sm-inline">&nbsp;<ng-container i18n>Share Links</ng-container></div>
+    </button>
+    <div ngbDropdownMenu aria-labelledby="shareLinksDropdown" class="shadow share-links-dropdown">
+      <ul class="list-group list-group-flush">
+        <li *ngIf="!shareLinks || shareLinks.length === 0" class="list-group-item fst-italic small text-center text-secondary" i18n>
+          No existing links
+        </li>
+        <li class="list-group-item" *ngFor="let link of shareLinks">
+          <div class="input-group input-group-sm w-100">
+            <input type="text" class="form-control" aria-label="Share link" [value]="getShareUrl(link)" readonly>
+            <span *ngIf="link.expiration" class="input-group-text">
+              {{ getDaysRemaining(link) }}
+            </span>
+            <button type="button" class="btn btn-sm btn-outline-primary" (click)="copy(link)">
+              <svg class="buttonicon" fill="currentColor">
+                <use *ngIf="copied !== link.id" xlink:href="assets/bootstrap-icons.svg#clipboard-fill" />
+                <use *ngIf="copied === link.id" xlink:href="assets/bootstrap-icons.svg#clipboard-check-fill" />
+              </svg><span class="visually-hidden" i18n>Copy</span>
+            </button>
+            <button *ngIf="canShare(link)" type="button" class="btn btn-sm btn-outline-primary" (click)="share(link)">
+              <svg class="buttonicon" fill="currentColor">
+                <use xlink:href="assets/bootstrap-icons.svg#box-arrow-up" />
+              </svg><span class="visually-hidden" i18n>Share</span>
+            </button>
+            <button type="button" class="btn btn-sm btn-outline-danger" (click)="delete(link)">
+                <svg class="buttonicon" fill="currentColor">
+                    <use xlink:href="assets/bootstrap-icons.svg#trash" />
+                </svg><span class="visually-hidden" i18n>Delete</span>
+            </button>
+          </div>
+          <span class="badge copied-badge bg-primary small fade ms-4 position-absolute top-50 translate-middle-y pe-none z-3" [class.show]="copied === link.id" i18n>Copied!</span>
+        </li>
+        <li class="list-group-item pt-3 pb-2">
+          <div class="input-group input-group-sm w-100">
+            <div class="form-check form-switch ms-auto">
+              <input class="form-check-input" type="checkbox" role="switch" id="versionSwitch" [(ngModel)]="archiveVersion">
+              <label class="form-check-label small" for="versionSwitch" i18n>Share archive version</label>
+            </div>
+          </div>
+          <div class="input-group input-group-sm w-100 mt-2">
+            <label class="input-group-text" for="addLink">Expires:</label>
+            <select class="form-select form-select-sm" [(ngModel)]="expirationDays">
+              <option *ngFor="let option of EXPIRATION_OPTIONS" [ngValue]="option.value">{{ option.label }}</option>
+            </select>
+            <button class="btn btn-sm btn-outline-primary ms-auto" type="button" (click)="createLink()" [disabled]="loading">
+              <div *ngIf="loading" class="spinner-border spinner-border-sm me-2" role="status"></div>
+              <svg *ngIf="!loading" class="buttonicon me-1" fill="currentColor">
+                <use xlink:href="assets/bootstrap-icons.svg#plus" />
+              </svg>
+              <ng-container i18n>Create</ng-container>
+            </button>
+          </div>
+        </li>
+      </ul>
+    </div>
+</div>
--- a/src-ui/src/app/components/common/share-links-dropdown/share-links-dropdown.component.scss
+++ b/src-ui/src/app/components/common/share-links-dropdown/share-links-dropdown.component.scss
@@ -0,0 +1,14 @@
+.share-links-dropdown {
+    min-width: 350px;
+
+    // correct position on mobile
+    @media (max-width: 575.98px) {
+        &.show {
+            margin-left: -175px !important;
+        }
+    }
+}
+
+.copied-badge {
+    right: 7.5em;
+}
--- a/src-ui/src/app/components/common/share-links-dropdown/share-links-dropdown.component.spec.ts
+++ b/src-ui/src/app/components/common/share-links-dropdown/share-links-dropdown.component.spec.ts
@@ -0,0 +1,195 @@
+import {
+  HttpTestingController,
+  HttpClientTestingModule,
+} from '@angular/common/http/testing'
+import {
+  ComponentFixture,
+  TestBed,
+  fakeAsync,
+  tick,
+} from '@angular/core/testing'
+import { FormsModule, ReactiveFormsModule } from '@angular/forms'
+import { of, throwError } from 'rxjs'
+import {
+  PaperlessFileVersion,
+  PaperlessShareLink,
+} from 'src/app/data/paperless-share-link'
+import { ShareLinkService } from 'src/app/services/rest/share-link.service'
+import { ToastService } from 'src/app/services/toast.service'
+import { environment } from 'src/environments/environment'
+import { ShareLinksDropdownComponent } from './share-links-dropdown.component'
+import { ClipboardService } from 'ngx-clipboard'
+
+describe('ShareLinksDropdownComponent', () => {
+  let component: ShareLinksDropdownComponent
+  let fixture: ComponentFixture<ShareLinksDropdownComponent>
+  let shareLinkService: ShareLinkService
+  let toastService: ToastService
+  let httpController: HttpTestingController
+  let clipboardService: ClipboardService
+
+  beforeEach(() => {
+    TestBed.configureTestingModule({
+      declarations: [ShareLinksDropdownComponent],
+      imports: [HttpClientTestingModule, FormsModule, ReactiveFormsModule],
+    })
+
+    fixture = TestBed.createComponent(ShareLinksDropdownComponent)
+    shareLinkService = TestBed.inject(ShareLinkService)
+    toastService = TestBed.inject(ToastService)
+    httpController = TestBed.inject(HttpTestingController)
+    clipboardService = TestBed.inject(ClipboardService)
+
+    component = fixture.componentInstance
+    fixture.detectChanges()
+  })
+
+  it('should support refresh to retrieve links', () => {
+    const getSpy = jest.spyOn(shareLinkService, 'getLinksForDocument')
+    component.documentId = 99
+
+    const now = new Date()
+    const expiration7days = new Date()
+    expiration7days.setDate(now.getDate() + 7)
+
+    getSpy.mockReturnValue(
+      of([
+        {
+          id: 1,
+          slug: '1234slug',
+          created: now.toISOString(),
+          document: 99,
+          file_version: PaperlessFileVersion.Archive,
+          expiration: expiration7days.toISOString(),
+        },
+        {
+          id: 1,
+          slug: '1234slug',
+          created: now.toISOString(),
+          document: 99,
+          file_version: PaperlessFileVersion.Original,
+          expiration: null,
+        },
+      ])
+    )
+
+    component.refresh()
+    expect(getSpy).toHaveBeenCalled()
+
+    fixture.detectChanges()
+
+    expect(component.shareLinks).toHaveLength(2)
+  })
+
+  it('should show error on refresh if needed', () => {
+    const toastSpy = jest.spyOn(toastService, 'showError')
+    jest
+      .spyOn(shareLinkService, 'getLinksForDocument')
+      .mockReturnValueOnce(throwError(() => new Error('Unable to get links')))
+    component.documentId = 99
+
+    component.refresh()
+    fixture.detectChanges()
+    expect(toastSpy).toHaveBeenCalled()
+  })
+
+  it('should support link creation then refresh & copy url', fakeAsync(() => {
+    const createSpy = jest.spyOn(shareLinkService, 'createLinkForDocument')
+    component.documentId = 99
+    component.expirationDays = 7
+    component.archiveVersion = false
+
+    const expiration = new Date()
+    expiration.setDate(expiration.getDate() + 7)
+
+    const copySpy = jest.spyOn(clipboardService, 'copy')
+    const refreshSpy = jest.spyOn(component, 'refresh')
+
+    component.createLink()
+    expect(createSpy).toHaveBeenCalledWith(99, 'original', expiration)
+
+    httpController.expectOne(`${environment.apiBaseUrl}share_links/`).flush({
+      id: 1,
+      slug: '1234slug',
+      document: 99,
+      expiration: expiration.toISOString(),
+    })
+    fixture.detectChanges()
+    tick(3000)
+
+    expect(copySpy).toHaveBeenCalled()
+    expect(refreshSpy).toHaveBeenCalled()
+  }))
+
+  it('should show error on link creation if needed', () => {
+    component.documentId = 99
+    component.expirationDays = 7
+
+    const expiration = new Date()
+    expiration.setDate(expiration.getDate() + 7)
+
+    const toastSpy = jest.spyOn(toastService, 'showError')
+
+    component.createLink()
+
+    httpController
+      .expectOne(`${environment.apiBaseUrl}share_links/`)
+      .flush(
+        { error: 'Share link error' },
+        { status: 500, statusText: 'error' }
+      )
+    fixture.detectChanges()
+
+    expect(toastSpy).toHaveBeenCalled()
+  })
+
+  it('should support delete links & refresh', () => {
+    const deleteSpy = jest.spyOn(shareLinkService, 'delete')
+    deleteSpy.mockReturnValue(of(true))
+    const refreshSpy = jest.spyOn(component, 'refresh')
+
+    component.delete({ id: 12 } as PaperlessShareLink)
+    fixture.detectChanges()
+    expect(deleteSpy).toHaveBeenCalledWith({ id: 12 })
+    expect(refreshSpy).toHaveBeenCalled()
+  })
+
+  it('should show error on delete if needed', () => {
+    const toastSpy = jest.spyOn(toastService, 'showError')
+    jest
+      .spyOn(shareLinkService, 'delete')
+      .mockReturnValueOnce(throwError(() => new Error('Unable to delete link')))
+    component.delete(null)
+    fixture.detectChanges()
+    expect(toastSpy).toHaveBeenCalled()
+  })
+
+  it('should format days remaining', () => {
+    const now = new Date()
+    const expiration7days = new Date()
+    expiration7days.setDate(now.getDate() + 7)
+    const expiration1day = new Date()
+    expiration1day.setDate(now.getDate() + 1)
+
+    expect(
+      component.getDaysRemaining({
+        expiration: expiration7days.toISOString(),
+      } as PaperlessShareLink)
+    ).toEqual('7 days')
+    expect(
+      component.getDaysRemaining({
+        expiration: expiration1day.toISOString(),
+      } as PaperlessShareLink)
+    ).toEqual('1 day')
+  })
+
+  // coverage
+  it('should support share', () => {
+    const link = { slug: '12345slug' } as PaperlessShareLink
+    if (!('share' in navigator))
+      Object.defineProperty(navigator, 'share', { value: (obj: any) => {} })
+    // const navigatorSpy = jest.spyOn(navigator, 'share')
+    component.share(link)
+    // expect(navigatorSpy).toHaveBeenCalledWith({ url: component.getShareUrl(link) })
+  })
+})
--- a/src-ui/src/app/components/common/share-links-dropdown/share-links-dropdown.component.ts
+++ b/src-ui/src/app/components/common/share-links-dropdown/share-links-dropdown.component.ts
@@ -0,0 +1,149 @@
+import { Component, Input, OnInit } from '@angular/core'
+import { first } from 'rxjs'
+import {
+  PaperlessShareLink,
+  PaperlessFileVersion,
+} from 'src/app/data/paperless-share-link'
+import { ShareLinkService } from 'src/app/services/rest/share-link.service'
+import { ToastService } from 'src/app/services/toast.service'
+import { environment } from 'src/environments/environment'
+import { ClipboardService } from 'ngx-clipboard'
+
+@Component({
+  selector: 'app-share-links-dropdown',
+  templateUrl: './share-links-dropdown.component.html',
+  styleUrls: ['./share-links-dropdown.component.scss'],
+})
+export class ShareLinksDropdownComponent implements OnInit {
+  EXPIRATION_OPTIONS = [
+    { label: $localize`1 day`, value: 1 },
+    { label: $localize`7 days`, value: 7 },
+    { label: $localize`30 days`, value: 30 },
+    { label: $localize`Never`, value: null },
+  ]
+
+  @Input()
+  title = $localize`Share Links`
+
+  _documentId: number
+
+  @Input()
+  set documentId(id: number) {
+    if (id !== undefined) {
+      this._documentId = id
+      this.refresh()
+    }
+  }
+
+  @Input()
+  disabled: boolean = false
+
+  shareLinks: PaperlessShareLink[]
+
+  loading: boolean = false
+
+  copied: number
+
+  expirationDays: number = 7
+
+  archiveVersion: boolean = true
+
+  constructor(
+    private shareLinkService: ShareLinkService,
+    private toastService: ToastService,
+    private clipboardService: ClipboardService
+  ) {}
+
+  ngOnInit(): void {
+    if (this._documentId !== undefined) this.refresh()
+  }
+
+  refresh() {
+    if (this._documentId === undefined) return
+    this.loading = true
+    this.shareLinkService
+      .getLinksForDocument(this._documentId)
+      .pipe(first())
+      .subscribe({
+        next: (results) => {
+          this.loading = false
+          this.shareLinks = results
+        },
+        error: (e) => {
+          this.toastService.showError(
+            $localize`Error retrieving links`,
+            10000,
+            e
+          )
+        },
+      })
+  }
+
+  getShareUrl(link: PaperlessShareLink): string {
+    return `${environment.apiBaseUrl.replace('api', 'share')}${link.slug}`
+  }
+
+  getDaysRemaining(link: PaperlessShareLink): string {
+    const days: number = Math.ceil(
+      (Date.parse(link.expiration) - Date.now()) / (1000 * 60 * 60 * 24)
+    )
+    return days === 1 ? $localize`1 day` : $localize`${days} days`
+  }
+
+  copy(link: PaperlessShareLink) {
+    this.clipboardService.copy(this.getShareUrl(link))
+    this.copied = link.id
+    setTimeout(() => {
+      this.copied = null
+    }, 3000)
+  }
+
+  canShare(link: PaperlessShareLink): boolean {
+    return (
+      navigator?.canShare && navigator.canShare({ url: this.getShareUrl(link) })
+    )
+  }
+
+  share(link: PaperlessShareLink) {
+    navigator.share({ url: this.getShareUrl(link) })
+  }
+
+  delete(link: PaperlessShareLink) {
+    this.shareLinkService.delete(link).subscribe({
+      next: () => {
+        this.refresh()
+      },
+      error: (e) => {
+        this.toastService.showError($localize`Error deleting link`, 10000, e)
+      },
+    })
+  }
+
+  createLink() {
+    let expiration
+    if (this.expirationDays) {
+      expiration = new Date()
+      expiration.setDate(expiration.getDate() + this.expirationDays)
+    }
+    this.loading = true
+    this.shareLinkService
+      .createLinkForDocument(
+        this._documentId,
+        this.archiveVersion
+          ? PaperlessFileVersion.Archive
+          : PaperlessFileVersion.Original,
+        expiration
+      )
+      .subscribe({
+        next: (result) => {
+          this.loading = false
+          this.copy(result)
+          this.refresh()
+        },
+        error: (e) => {
+          this.loading = false
+          this.toastService.showError($localize`Error creating link`, 10000, e)
+        },
+      })
+  }
+}
--- a/src-ui/src/app/components/common/toasts/toasts.component.spec.ts
+++ b/src-ui/src/app/components/common/toasts/toasts.component.spec.ts
@@ -10,6 +10,7 @@ import { ComponentFixture } from '@angular/core/testing'
 import { HttpClientTestingModule } from '@angular/common/http/testing'
 import { of } from 'rxjs'
 import { NgbModule } from '@ng-bootstrap/ng-bootstrap'
+import { ClipboardService } from 'ngx-clipboard'

 const toasts = [
  {
@@ -41,6 +42,7 @@ describe('ToastsComponent', () => {
  let component: ToastsComponent
  let fixture: ComponentFixture<ToastsComponent>
  let toastService: ToastService
+  let clipboardService: ClipboardService

  beforeEach(async () => {
    TestBed.configureTestingModule({
@@ -57,9 +59,10 @@ describe('ToastsComponent', () => {
    }).compileComponents()

    fixture = TestBed.createComponent(ToastsComponent)
-    component = fixture.componentInstance
-
    toastService = TestBed.inject(ToastService)
+    clipboardService = TestBed.inject(ClipboardService)
+
+    component = fixture.componentInstance

    fixture.detectChanges()
  })
@@ -114,7 +117,7 @@ describe('ToastsComponent', () => {
      'Error 2 message details'
    )

-    const copySpy = jest.spyOn(navigator.clipboard, 'writeText')
+    const copySpy = jest.spyOn(clipboardService, 'copy')
    component.copyError(toasts[2].error)
    expect(copySpy).toHaveBeenCalled()

--- a/src-ui/src/app/components/common/toasts/toasts.component.ts
+++ b/src-ui/src/app/components/common/toasts/toasts.component.ts
@@ -1,6 +1,7 @@
 import { Component, OnDestroy, OnInit } from '@angular/core'
 import { Subscription } from 'rxjs'
 import { Toast, ToastService } from 'src/app/services/toast.service'
+import { ClipboardService } from 'ngx-clipboard'

@Component({
  selector: 'app-toasts',
@@ -8,7 +9,10 @@ import { Toast, ToastService } from 'src/app/services/toast.service'
  styleUrls: ['./toasts.component.scss'],
 })
 export class ToastsComponent implements OnInit, OnDestroy {
-  constructor(private toastService: ToastService) {}
+  constructor(
+    private toastService: ToastService,
+    private clipboardService: ClipboardService
+  ) {}

  private subscription: Subscription

@@ -45,7 +49,7 @@ export class ToastsComponent implements OnInit, OnDestroy {
  }

  public copyError(error: any) {
-    navigator.clipboard.writeText(JSON.stringify(error))
+    this.clipboardService.copy(JSON.stringify(error))
    this.copied = true
    setTimeout(() => {
      this.copied = false