import { DecimalPipe, NgTemplateOutlet } from '@angular/common' import { Component, inject, output, signal } from '@angular/core' import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap' import { first } from 'rxjs' import { BootstrapIconComponent } from 'src/app/components/common/bootstrap-icon/bootstrap-icon.component' import { SETTINGS_KEYS } from 'src/app/data/ui-settings' import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe' import { PermissionAction, PermissionsService, PermissionType, } from 'src/app/services/permissions.service' import { AppRelease, RemoteVersionService, } from 'src/app/services/rest/remote-version.service' import { SettingsService } from 'src/app/services/settings.service' const REPO_URL = 'https://github.com/paperless-ngx/paperless-ngx' const RELEASES_URL = `${REPO_URL}/releases` const DISCUSSIONS_URL = `${REPO_URL}/discussions/new/choose` const UPDATING_DOCS_URL = 'https://docs.paperless-ngx.com/administration/#updating' /** * Tweak GitHub release HTML: open links in a new tab, add no referrer etc, * drop inline svgs and GH `data-*` attributes. Angular sanitizes all of this anyway. */ export function prepareReleaseHtml(html: string): string { const doc = new DOMParser().parseFromString(html, 'text/html') doc.querySelectorAll('svg').forEach((svg) => svg.remove()) doc.body.querySelectorAll('*').forEach((el) => { for (const attr of Array.from(el.attributes)) { if (attr.name.startsWith('data-')) el.removeAttribute(attr.name) } }) doc.querySelectorAll('a').forEach((a) => { a.setAttribute('target', '_blank') a.setAttribute('rel', 'noopener noreferrer nofollow') }) return doc.body.innerHTML } @Component({ selector: 'pngx-release-notes-dialog', templateUrl: './release-notes-dialog.component.html', styleUrls: ['./release-notes-dialog.component.scss'], imports: [ BootstrapIconComponent, CustomDatePipe, NgTemplateOutlet, DecimalPipe, ], }) export class ReleaseNotesDialogComponent { readonly activeModal = inject(NgbActiveModal) private readonly remoteVersionService = inject(RemoteVersionService) private readonly settingsService = inject(SettingsService) private readonly permissionsService = inject(PermissionsService) readonly since = signal(null) readonly until = signal(null) readonly releases = signal(null) readonly stars = signal(null) readonly loading = signal(false) readonly version: string = this.settingsService.get(SETTINGS_KEYS.VERSION) readonly updateCheckingEnabled = signal( this.settingsService.get(SETTINGS_KEYS.UPDATE_CHECKING_ENABLED) ) readonly updateCheckingIsSet = signal( this.settingsService.updateCheckingIsSet ) readonly canChangeUpdateChecking = this.permissionsService.currentUserCan( PermissionAction.Change, PermissionType.UISettings ) readonly updateCheckingChosen = output() readonly repoUrl = REPO_URL readonly releasesUrl = RELEASES_URL readonly discussionsUrl = DISCUSSIONS_URL readonly updatingDocsUrl = UPDATING_DOCS_URL get releaseUrl(): string { const version = this.until() ?? this.version return version ? `${RELEASES_URL}/tag/v${version}` : RELEASES_URL } /** * Load notes for releases after `since` up to `until` (default: the * running version), or just the `until` version's notes if `since` is null. */ load(since: string | null, until: string | null = null): void { this.since.set(since) this.until.set(until) if (!this.updateCheckingEnabled()) return this.loading.set(true) this.remoteVersionService .getReleaseNotes(since ?? undefined, until ?? undefined) .pipe(first()) .subscribe({ next: (notes) => { this.releases.set( notes.releases.map((release) => ({ ...release, body_html: prepareReleaseHtml(release.body_html), })) ) this.stars.set(notes.stars ?? null) this.loading.set(false) }, error: () => { this.releases.set([]) this.loading.set(false) }, }) } setUpdateChecking(enable: boolean): void { this.updateCheckingIsSet.set(true) this.updateCheckingEnabled.set(enable) this.updateCheckingChosen.emit(enable) if (enable) this.load(this.since(), this.until()) } close(): void { this.activeModal.close() } }