diff --git a/docs/api.md b/docs/api.md index 0eacd7913..8096b84e9 100644 --- a/docs/api.md +++ b/docs/api.md @@ -21,6 +21,7 @@ The API provides the following main endpoints: - `/api/groups/`: Full CRUD support. - `/api/share_links/`: Full CRUD support. - `/api/custom_fields/`: Full CRUD support. +- `/api/profile/`: GET, PATCH All of these endpoints except for the logging endpoint allow you to fetch (and edit and delete where appropriate) individual objects by @@ -157,6 +158,10 @@ The REST api provides three different forms of authentication. 3. Token authentication + You can create (or re-create) an API token by opening the "My Profile" + link in the user dropdown found in the web UI and clicking the circular + arrow button. + Paperless also offers an endpoint to acquire authentication tokens. POST a username and password as a form or json string to @@ -168,7 +173,7 @@ The REST api provides three different forms of authentication. Authorization: Token ``` - Tokens can be managed and revoked in the paperless admin. + Tokens can also be managed in the Django admin. ## Searching for documents diff --git a/src-ui/messages.xlf b/src-ui/messages.xlf index f101ae0f3..1b94018f3 100644 --- a/src-ui/messages.xlf +++ b/src-ui/messages.xlf @@ -403,11 +403,11 @@ src/app/components/app-frame/app-frame.component.html - 225 + 230 src/app/components/app-frame/app-frame.component.html - 228 + 233 @@ -496,15 +496,15 @@ src/app/components/app-frame/app-frame.component.html - 45 + 50 src/app/components/app-frame/app-frame.component.html - 203 + 208 src/app/components/app-frame/app-frame.component.html - 206 + 211 @@ -973,7 +973,7 @@ src/app/components/app-frame/app-frame.component.html - 91 + 96 @@ -1329,6 +1329,10 @@ src/app/components/common/edit-dialog/user-edit-dialog/user-edit-dialog.component.html 36 + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.html + 54 + src/app/components/document-detail/document-detail.component.html 93 @@ -1396,7 +1400,7 @@ src/app/components/app-frame/app-frame.component.ts - 119 + 116 @@ -1428,7 +1432,7 @@ src/app/components/app-frame/app-frame.component.html - 217 + 222 @@ -1630,11 +1634,11 @@ src/app/components/app-frame/app-frame.component.html - 210 + 215 src/app/components/app-frame/app-frame.component.html - 213 + 218 @@ -1780,6 +1784,10 @@ src/app/components/admin/users-groups/users-groups.component.ts 89 + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.ts + 144 + Saved user "". @@ -1961,37 +1969,44 @@ 39 + + My Profile + + src/app/components/app-frame/app-frame.component.html + 45 + + Logout src/app/components/app-frame/app-frame.component.html - 50 + 55 Documentation src/app/components/app-frame/app-frame.component.html - 56 + 61 src/app/components/app-frame/app-frame.component.html - 232 + 237 src/app/components/app-frame/app-frame.component.html - 235 + 240 Dashboard src/app/components/app-frame/app-frame.component.html - 75 + 80 src/app/components/app-frame/app-frame.component.html - 78 + 83 src/app/components/dashboard/dashboard.component.html @@ -2002,11 +2017,11 @@ Documents src/app/components/app-frame/app-frame.component.html - 82 + 87 src/app/components/app-frame/app-frame.component.html - 85 + 90 src/app/components/document-list/document-list.component.ts @@ -2033,36 +2048,36 @@ Open documents src/app/components/app-frame/app-frame.component.html - 118 + 123 Close all src/app/components/app-frame/app-frame.component.html - 134 + 139 src/app/components/app-frame/app-frame.component.html - 137 + 142 Manage src/app/components/app-frame/app-frame.component.html - 144 + 149 Correspondents src/app/components/app-frame/app-frame.component.html - 148 + 153 src/app/components/app-frame/app-frame.component.html - 151 + 156 src/app/components/dashboard/widgets/statistics-widget/statistics-widget.component.html @@ -2073,11 +2088,11 @@ Tags src/app/components/app-frame/app-frame.component.html - 155 + 160 src/app/components/app-frame/app-frame.component.html - 158 + 163 src/app/components/common/input/tags/tags.component.ts @@ -2104,11 +2119,11 @@ Document Types src/app/components/app-frame/app-frame.component.html - 162 + 167 src/app/components/app-frame/app-frame.component.html - 165 + 170 src/app/components/dashboard/widgets/statistics-widget/statistics-widget.component.html @@ -2119,11 +2134,11 @@ Storage Paths src/app/components/app-frame/app-frame.component.html - 169 + 174 src/app/components/app-frame/app-frame.component.html - 172 + 177 src/app/components/dashboard/widgets/statistics-widget/statistics-widget.component.html @@ -2134,11 +2149,11 @@ Custom Fields src/app/components/app-frame/app-frame.component.html - 176 + 181 src/app/components/app-frame/app-frame.component.html - 179 + 184 src/app/components/common/custom-fields-dropdown/custom-fields-dropdown.component.html @@ -2153,102 +2168,102 @@ Consumption templates src/app/components/app-frame/app-frame.component.html - 183 + 188 Templates src/app/components/app-frame/app-frame.component.html - 186 + 191 Mail src/app/components/app-frame/app-frame.component.html - 190 + 195 src/app/components/app-frame/app-frame.component.html - 193 + 198 Administration src/app/components/app-frame/app-frame.component.html - 199 + 204 File Tasks src/app/components/app-frame/app-frame.component.html - 221 + 226 GitHub src/app/components/app-frame/app-frame.component.html - 241 + 246 is available. src/app/components/app-frame/app-frame.component.html - 247 + 252 Click to view. src/app/components/app-frame/app-frame.component.html - 247 + 252 Paperless-ngx can automatically check for updates src/app/components/app-frame/app-frame.component.html - 251 + 256 How does this work? src/app/components/app-frame/app-frame.component.html - 258,260 + 263,265 Update available src/app/components/app-frame/app-frame.component.html - 269 + 274 Sidebar views updated src/app/components/app-frame/app-frame.component.ts - 247 + 252 Error updating sidebar views src/app/components/app-frame/app-frame.component.ts - 250 + 255 An error occurred while saving update checking settings. src/app/components/app-frame/app-frame.component.ts - 271 + 276 @@ -2623,6 +2638,10 @@ src/app/components/common/permissions-dialog/permissions-dialog.component.html 20 + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.html + 53 + src/app/components/common/select-dialog/select-dialog.component.html 12 @@ -2843,6 +2862,10 @@ src/app/components/common/edit-dialog/user-edit-dialog/user-edit-dialog.component.html 12 + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.html + 18 + Password is token @@ -3307,6 +3330,10 @@ src/app/components/common/edit-dialog/user-edit-dialog/user-edit-dialog.component.html 11 + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.html + 8 + First name @@ -3314,6 +3341,10 @@ src/app/components/common/edit-dialog/user-edit-dialog/user-edit-dialog.component.html 13 + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.html + 28 + Last name @@ -3321,6 +3352,10 @@ src/app/components/common/edit-dialog/user-edit-dialog/user-edit-dialog.component.html 14 + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.html + 29 + Active @@ -3483,6 +3518,13 @@ 155 + + Show password + + src/app/components/common/input/password/password.component.html + 5 + + Edit Permissions @@ -3637,6 +3679,109 @@ 61 + + Edit Profile + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.html + 3 + + + + Confirm Email + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.html + 13 + + + + Confirm Password + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.html + 23 + + + + API Auth Token + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.html + 31 + + + + Copy + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.html + 35 + + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.html + 39 + + + src/app/components/common/share-links-dropdown/share-links-dropdown.component.html + 23 + + + + Regenerate auth token + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.html + 41 + + + + Copied! + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.html + 47 + + + src/app/components/common/share-links-dropdown/share-links-dropdown.component.html + 36 + + + + Warning: changing the token cannot be undone + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.html + 49 + + + + Emails must match + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.ts + 94 + + + + Passwords must match + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.ts + 122 + + + + Profile updated successfully + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.ts + 141 + + + + Error saving profile + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.ts + 153 + + + + Error generating auth token + + src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.ts + 170 + + Select @@ -3677,13 +3822,6 @@ 10,12 - - Copy - - src/app/components/common/share-links-dropdown/share-links-dropdown.component.html - 23 - - Share @@ -3691,13 +3829,6 @@ 28 - - Copied! - - src/app/components/common/share-links-dropdown/share-links-dropdown.component.html - 36 - - Share archive version @@ -3727,7 +3858,7 @@ src/app/components/common/share-links-dropdown/share-links-dropdown.component.ts - 90 + 93 @@ -3762,21 +3893,21 @@ days src/app/components/common/share-links-dropdown/share-links-dropdown.component.ts - 90 + 93 Error deleting link src/app/components/common/share-links-dropdown/share-links-dropdown.component.ts - 117 + 120 Error creating link src/app/components/common/share-links-dropdown/share-links-dropdown.component.ts - 145 + 148 diff --git a/src-ui/src/app/app.module.ts b/src-ui/src/app/app.module.ts index e3cef8c95..684cf6d18 100644 --- a/src-ui/src/app/app.module.ts +++ b/src-ui/src/app/app.module.ts @@ -105,6 +105,7 @@ import { FileDropComponent } from './components/file-drop/file-drop.component' import { CustomFieldsComponent } from './components/manage/custom-fields/custom-fields.component' import { CustomFieldEditDialogComponent } from './components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component' import { CustomFieldsDropdownComponent } from './components/common/custom-fields-dropdown/custom-fields-dropdown.component' +import { ProfileEditDialogComponent } from './components/common/profile-edit-dialog/profile-edit-dialog.component' import localeAf from '@angular/common/locales/af' import localeAr from '@angular/common/locales/ar' @@ -256,6 +257,7 @@ function initializeApp(settings: SettingsService) { CustomFieldsComponent, CustomFieldEditDialogComponent, CustomFieldsDropdownComponent, + ProfileEditDialogComponent, ], imports: [ BrowserModule, diff --git a/src-ui/src/app/components/admin/users-groups/users-groups.component.ts b/src-ui/src/app/components/admin/users-groups/users-groups.component.ts index a9ce1d600..8f1751092 100644 --- a/src-ui/src/app/components/admin/users-groups/users-groups.component.ts +++ b/src-ui/src/app/components/admin/users-groups/users-groups.component.ts @@ -89,7 +89,7 @@ export class UsersAndGroupsComponent $localize`Password has been changed, you will be logged out momentarily.` ) setTimeout(() => { - window.location.href = `${window.location.origin}/accounts/logout/?next=/accounts/login/` + window.location.href = `${window.location.origin}/accounts/logout/?next=/accounts/login/?next=/` }, 2500) } else { this.toastService.showInfo( diff --git a/src-ui/src/app/components/app-frame/app-frame.component.html b/src-ui/src/app/components/app-frame/app-frame.component.html index a710600ef..556252670 100644 --- a/src-ui/src/app/components/app-frame/app-frame.component.html +++ b/src-ui/src/app/components/app-frame/app-frame.component.html @@ -39,6 +39,11 @@

Logged in as {{this.settingsService.displayName}}

+ diff --git a/src-ui/src/app/components/app-frame/app-frame.component.spec.ts b/src-ui/src/app/components/app-frame/app-frame.component.spec.ts index 7b8bf4bce..152429358 100644 --- a/src-ui/src/app/components/app-frame/app-frame.component.spec.ts +++ b/src-ui/src/app/components/app-frame/app-frame.component.spec.ts @@ -9,7 +9,7 @@ import { fakeAsync, tick, } from '@angular/core/testing' -import { NgbModule } from '@ng-bootstrap/ng-bootstrap' +import { NgbModal, NgbModalModule, NgbModule } from '@ng-bootstrap/ng-bootstrap' import { BrowserModule } from '@angular/platform-browser' import { RouterTestingModule } from '@angular/router/testing' import { SettingsService } from 'src/app/services/settings.service' @@ -32,6 +32,7 @@ import { routes } from 'src/app/app-routing.module' import { PermissionsGuard } from 'src/app/guards/permissions.guard' import { CdkDragDrop, DragDropModule } from '@angular/cdk/drag-drop' import { PaperlessSavedView } from 'src/app/data/paperless-saved-view' +import { ProfileEditDialogComponent } from '../common/profile-edit-dialog/profile-edit-dialog.component' const saved_views = [ { @@ -86,6 +87,7 @@ describe('AppFrameComponent', () => { let documentListViewService: DocumentListViewService let router: Router let savedViewSpy + let modalService: NgbModal beforeEach(async () => { TestBed.configureTestingModule({ @@ -98,6 +100,7 @@ describe('AppFrameComponent', () => { FormsModule, ReactiveFormsModule, DragDropModule, + NgbModalModule, ], providers: [ SettingsService, @@ -120,6 +123,7 @@ describe('AppFrameComponent', () => { ToastService, OpenDocumentsService, SearchService, + NgbModal, { provide: ActivatedRoute, useValue: { @@ -148,6 +152,7 @@ describe('AppFrameComponent', () => { openDocumentsService = TestBed.inject(OpenDocumentsService) searchService = TestBed.inject(SearchService) documentListViewService = TestBed.inject(DocumentListViewService) + modalService = TestBed.inject(NgbModal) router = TestBed.inject(Router) jest @@ -363,4 +368,12 @@ describe('AppFrameComponent', () => { >) expect(toastSpy).toHaveBeenCalled() }) + + it('should support edit profile', () => { + const modalSpy = jest.spyOn(modalService, 'open') + component.editProfile() + expect(modalSpy).toHaveBeenCalledWith(ProfileEditDialogComponent, { + backdrop: 'static', + }) + }) }) diff --git a/src-ui/src/app/components/app-frame/app-frame.component.ts b/src-ui/src/app/components/app-frame/app-frame.component.ts index 0c8f149c1..f346dc089 100644 --- a/src-ui/src/app/components/app-frame/app-frame.component.ts +++ b/src-ui/src/app/components/app-frame/app-frame.component.ts @@ -39,6 +39,8 @@ import { CdkDragDrop, moveItemInArray, } from '@angular/cdk/drag-drop' +import { NgbModal } from '@ng-bootstrap/ng-bootstrap' +import { ProfileEditDialogComponent } from '../common/profile-edit-dialog/profile-edit-dialog.component' @Component({ selector: 'pngx-app-frame', @@ -69,6 +71,7 @@ export class AppFrameComponent public settingsService: SettingsService, public tasksService: TasksService, private readonly toastService: ToastService, + private modalService: NgbModal, permissionsService: PermissionsService ) { super() @@ -121,6 +124,13 @@ export class AppFrameComponent this.isMenuCollapsed = true } + editProfile() { + this.modalService.open(ProfileEditDialogComponent, { + backdrop: 'static', + }) + this.closeMenu() + } + get openDocuments(): PaperlessDocument[] { return this.openDocumentsService.getOpenDocuments() } diff --git a/src-ui/src/app/components/common/input/password/password.component.html b/src-ui/src/app/components/common/input/password/password.component.html index 57cdd6de8..dc285ac7b 100644 --- a/src-ui/src/app/components/common/input/password/password.component.html +++ b/src-ui/src/app/components/common/input/password/password.component.html @@ -1,8 +1,15 @@
- - +
+ + +
{{error}}
+
diff --git a/src-ui/src/app/components/common/input/password/password.component.spec.ts b/src-ui/src/app/components/common/input/password/password.component.spec.ts index 80ad853d7..1788104a6 100644 --- a/src-ui/src/app/components/common/input/password/password.component.spec.ts +++ b/src-ui/src/app/components/common/input/password/password.component.spec.ts @@ -5,6 +5,7 @@ import { NG_VALUE_ACCESSOR, } from '@angular/forms' import { PasswordComponent } from './password.component' +import { By } from '@angular/platform-browser' describe('PasswordComponent', () => { let component: PasswordComponent @@ -33,4 +34,26 @@ describe('PasswordComponent', () => { // fixture.detectChanges() // expect(component.value).toEqual('foo') }) + + it('should support toggling field visibility', () => { + expect(input.type).toEqual('password') + component.showReveal = true + fixture.detectChanges() + fixture.debugElement.query(By.css('button')).triggerEventHandler('click') + fixture.detectChanges() + expect(input.type).toEqual('text') + }) + + it('should empty field if password is obfuscated on focus', () => { + component.value = '*********' + component.onFocus() + expect(component.value).toEqual('') + component.onFocusOut() + expect(component.value).toEqual('**********') + }) + + it('should disable toggle button if no real password', () => { + component.value = '*********' + expect(component.disableRevealToggle).toBeTruthy() + }) }) diff --git a/src-ui/src/app/components/common/input/password/password.component.ts b/src-ui/src/app/components/common/input/password/password.component.ts index ce0284a77..26f5a94e8 100644 --- a/src-ui/src/app/components/common/input/password/password.component.ts +++ b/src-ui/src/app/components/common/input/password/password.component.ts @@ -1,4 +1,4 @@ -import { Component, forwardRef } from '@angular/core' +import { Component, Input, forwardRef } from '@angular/core' import { NG_VALUE_ACCESSOR } from '@angular/forms' import { AbstractInputComponent } from '../abstract-input' @@ -15,7 +15,32 @@ import { AbstractInputComponent } from '../abstract-input' styleUrls: ['./password.component.scss'], }) export class PasswordComponent extends AbstractInputComponent { - constructor() { - super() + @Input() + showReveal: boolean = false + + @Input() + autocomplete: string + + public textVisible: boolean = false + + public toggleVisibility(): void { + this.textVisible = !this.textVisible + } + + public onFocus() { + if (this.value?.replace(/\*/g, '').length === 0) { + this.writeValue('') + } + } + + public onFocusOut() { + if (this.value?.length === 0) { + this.writeValue('**********') + this.onChange(this.value) + } + } + + get disableRevealToggle(): boolean { + return this.value?.replace(/\*/g, '').length === 0 } } diff --git a/src-ui/src/app/components/common/input/text/text.component.html b/src-ui/src/app/components/common/input/text/text.component.html index 98714e553..47ec804c6 100644 --- a/src-ui/src/app/components/common/input/text/text.component.html +++ b/src-ui/src/app/components/common/input/text/text.component.html @@ -9,7 +9,7 @@
- +
{{error}} diff --git a/src-ui/src/app/components/common/input/text/text.component.ts b/src-ui/src/app/components/common/input/text/text.component.ts index 4060977d4..a546e2e39 100644 --- a/src-ui/src/app/components/common/input/text/text.component.ts +++ b/src-ui/src/app/components/common/input/text/text.component.ts @@ -1,4 +1,4 @@ -import { Component, forwardRef } from '@angular/core' +import { Component, Input, forwardRef } from '@angular/core' import { NG_VALUE_ACCESSOR } from '@angular/forms' import { AbstractInputComponent } from '../abstract-input' @@ -15,6 +15,9 @@ import { AbstractInputComponent } from '../abstract-input' styleUrls: ['./text.component.scss'], }) export class TextComponent extends AbstractInputComponent { + @Input() + autocomplete: string + constructor() { super() } diff --git a/src-ui/src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.html b/src-ui/src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.html new file mode 100644 index 000000000..b6423b796 --- /dev/null +++ b/src-ui/src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.html @@ -0,0 +1,56 @@ +
+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ +
+
+
+
+ +
+
+
+
+ + +
+ +
+
+ + + +
+ Copied! +
+
Warning: changing the token cannot be undone
+
+
+
+ + +
+
diff --git a/src-ui/src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.scss b/src-ui/src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.scss new file mode 100644 index 000000000..62eb6b8cf --- /dev/null +++ b/src-ui/src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.scss @@ -0,0 +1,9 @@ +::ng-deep { + .accordion-body .mb-3 { + margin: 0 !important; // hack-ish, for animation + } +} + +.copied-badge { + right: 8em; +} diff --git a/src-ui/src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.spec.ts b/src-ui/src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.spec.ts new file mode 100644 index 000000000..0b300bd74 --- /dev/null +++ b/src-ui/src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.spec.ts @@ -0,0 +1,222 @@ +import { + ComponentFixture, + TestBed, + fakeAsync, + tick, +} from '@angular/core/testing' + +import { ProfileEditDialogComponent } from './profile-edit-dialog.component' +import { ProfileService } from 'src/app/services/profile.service' +import { FormsModule, ReactiveFormsModule } from '@angular/forms' +import { + NgbAccordionModule, + NgbActiveModal, + NgbModal, + NgbModalModule, +} from '@ng-bootstrap/ng-bootstrap' +import { HttpClientModule } from '@angular/common/http' +import { TextComponent } from '../input/text/text.component' +import { PasswordComponent } from '../input/password/password.component' +import { of, throwError } from 'rxjs' +import { ToastService } from 'src/app/services/toast.service' +import { Clipboard } from '@angular/cdk/clipboard' + +const profile = { + email: 'foo@bar.com', + password: '*********', + first_name: 'foo', + last_name: 'bar', + auth_token: '123456789abcdef', +} + +describe('ProfileEditDialogComponent', () => { + let component: ProfileEditDialogComponent + let fixture: ComponentFixture + let profileService: ProfileService + let toastService: ToastService + let clipboard: Clipboard + + beforeEach(() => { + TestBed.configureTestingModule({ + declarations: [ + ProfileEditDialogComponent, + TextComponent, + PasswordComponent, + ], + providers: [NgbActiveModal], + imports: [ + HttpClientModule, + ReactiveFormsModule, + FormsModule, + NgbModalModule, + NgbAccordionModule, + ], + }) + profileService = TestBed.inject(ProfileService) + toastService = TestBed.inject(ToastService) + clipboard = TestBed.inject(Clipboard) + fixture = TestBed.createComponent(ProfileEditDialogComponent) + component = fixture.componentInstance + fixture.detectChanges() + }) + + it('should get profile on init, display in form', () => { + const getSpy = jest.spyOn(profileService, 'get') + getSpy.mockReturnValue(of(profile)) + component.ngOnInit() + expect(getSpy).toHaveBeenCalled() + fixture.detectChanges() + expect(component.form.get('email').value).toEqual(profile.email) + }) + + it('should update profile on save, display error if needed', () => { + const newProfile = { + email: 'foo@bar2.com', + password: profile.password, + first_name: 'foo2', + last_name: profile.last_name, + auth_token: profile.auth_token, + } + const updateSpy = jest.spyOn(profileService, 'update') + const errorSpy = jest.spyOn(toastService, 'showError') + updateSpy.mockReturnValueOnce(throwError(() => new Error('failed to save'))) + component.save() + expect(errorSpy).toHaveBeenCalled() + + updateSpy.mockClear() + const infoSpy = jest.spyOn(toastService, 'showInfo') + component.form.patchValue(newProfile) + updateSpy.mockReturnValueOnce(of(newProfile)) + component.save() + expect(updateSpy).toHaveBeenCalledWith(newProfile) + expect(infoSpy).toHaveBeenCalled() + }) + + it('should close on cancel', () => { + const closeSpy = jest.spyOn(component.activeModal, 'close') + component.cancel() + expect(closeSpy).toHaveBeenCalled() + }) + + it('should show additional confirmation field when email changes, warn with error & disable save', () => { + expect(component.form.get('email_confirm').enabled).toBeFalsy() + const getSpy = jest.spyOn(profileService, 'get') + getSpy.mockReturnValue(of(profile)) + component.ngOnInit() + component.form.get('email').patchValue('foo@bar2.com') + component.onEmailKeyUp({ target: { value: 'foo@bar2.com' } } as any) + fixture.detectChanges() + expect(component.form.get('email_confirm').enabled).toBeTruthy() + expect(fixture.debugElement.nativeElement.textContent).toContain( + 'Emails must match' + ) + expect(component.saveDisabled).toBeTruthy() + + component.form.get('email_confirm').patchValue('foo@bar2.com') + component.onEmailConfirmKeyUp({ target: { value: 'foo@bar2.com' } } as any) + fixture.detectChanges() + expect(fixture.debugElement.nativeElement.textContent).not.toContain( + 'Emails must match' + ) + expect(component.saveDisabled).toBeFalsy() + + component.form.get('email').patchValue(profile.email) + fixture.detectChanges() + expect(component.form.get('email_confirm').enabled).toBeFalsy() + expect(fixture.debugElement.nativeElement.textContent).not.toContain( + 'Emails must match' + ) + expect(component.saveDisabled).toBeFalsy() + }) + + it('should show additional confirmation field when password changes, warn with error & disable save', () => { + expect(component.form.get('password_confirm').enabled).toBeFalsy() + const getSpy = jest.spyOn(profileService, 'get') + getSpy.mockReturnValue(of(profile)) + component.ngOnInit() + component.form.get('password').patchValue('new*pass') + component.onPasswordKeyUp({ + target: { value: 'new*pass', tagName: 'input' }, + } as any) + component.onPasswordKeyUp({ target: { tagName: 'button' } } as any) // coverage + fixture.detectChanges() + expect(component.form.get('password_confirm').enabled).toBeTruthy() + expect(fixture.debugElement.nativeElement.textContent).toContain( + 'Passwords must match' + ) + expect(component.saveDisabled).toBeTruthy() + + component.form.get('password_confirm').patchValue('new*pass') + component.onPasswordConfirmKeyUp({ target: { value: 'new*pass' } } as any) + fixture.detectChanges() + expect(fixture.debugElement.nativeElement.textContent).not.toContain( + 'Passwords must match' + ) + expect(component.saveDisabled).toBeFalsy() + + component.form.get('password').patchValue(profile.password) + fixture.detectChanges() + expect(component.form.get('password_confirm').enabled).toBeFalsy() + expect(fixture.debugElement.nativeElement.textContent).not.toContain( + 'Passwords must match' + ) + expect(component.saveDisabled).toBeFalsy() + }) + + it('should logout on save if password changed', fakeAsync(() => { + const getSpy = jest.spyOn(profileService, 'get') + getSpy.mockReturnValue(of(profile)) + component.ngOnInit() + component['newPassword'] = 'new*pass' + component.form.get('password').patchValue('new*pass') + component.form.get('password_confirm').patchValue('new*pass') + + const updateSpy = jest.spyOn(profileService, 'update') + updateSpy.mockReturnValue(of(null)) + Object.defineProperty(window, 'location', { + value: { + href: 'http://localhost/', + }, + writable: true, // possibility to override + }) + component.save() + expect(updateSpy).toHaveBeenCalled() + tick(2600) + expect(window.location.href).toContain('logout') + })) + + it('should support auth token copy', fakeAsync(() => { + const getSpy = jest.spyOn(profileService, 'get') + getSpy.mockReturnValue(of(profile)) + component.ngOnInit() + const copySpy = jest.spyOn(clipboard, 'copy') + component.copyAuthToken() + expect(copySpy).toHaveBeenCalledWith(profile.auth_token) + expect(component.copied).toBeTruthy() + tick(3000) + expect(component.copied).toBeFalsy() + })) + + it('should support generate token, display error if needed', () => { + const getSpy = jest.spyOn(profileService, 'get') + getSpy.mockReturnValue(of(profile)) + + const generateSpy = jest.spyOn(profileService, 'generateAuthToken') + const errorSpy = jest.spyOn(toastService, 'showError') + generateSpy.mockReturnValueOnce( + throwError(() => new Error('failed to generate')) + ) + component.generateAuthToken() + expect(errorSpy).toHaveBeenCalled() + + generateSpy.mockClear() + const newToken = '789101112hijk' + generateSpy.mockReturnValueOnce(of(newToken)) + component.generateAuthToken() + expect(generateSpy).toHaveBeenCalled() + expect(component.form.get('auth_token').value).not.toEqual( + profile.auth_token + ) + expect(component.form.get('auth_token').value).toEqual(newToken) + }) +}) diff --git a/src-ui/src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.ts b/src-ui/src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.ts new file mode 100644 index 000000000..19391ce28 --- /dev/null +++ b/src-ui/src/app/components/common/profile-edit-dialog/profile-edit-dialog.component.ts @@ -0,0 +1,184 @@ +import { Component, OnDestroy, OnInit } from '@angular/core' +import { FormControl, FormGroup } from '@angular/forms' +import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap' +import { ProfileService } from 'src/app/services/profile.service' +import { ToastService } from 'src/app/services/toast.service' +import { Subject, takeUntil } from 'rxjs' +import { Clipboard } from '@angular/cdk/clipboard' + +@Component({ + selector: 'pngx-profile-edit-dialog', + templateUrl: './profile-edit-dialog.component.html', + styleUrls: ['./profile-edit-dialog.component.scss'], +}) +export class ProfileEditDialogComponent implements OnInit, OnDestroy { + public networkActive: boolean = false + public error: any + private unsubscribeNotifier: Subject = new Subject() + + public form = new FormGroup({ + email: new FormControl(''), + email_confirm: new FormControl({ value: null, disabled: true }), + password: new FormControl(null), + password_confirm: new FormControl({ value: null, disabled: true }), + first_name: new FormControl(''), + last_name: new FormControl(''), + auth_token: new FormControl(''), + }) + + private currentPassword: string + private newPassword: string + private passwordConfirm: string + public showPasswordConfirm: boolean = false + + private currentEmail: string + private newEmail: string + private emailConfirm: string + public showEmailConfirm: boolean = false + + public copied: boolean = false + + constructor( + private profileService: ProfileService, + public activeModal: NgbActiveModal, + private toastService: ToastService, + private clipboard: Clipboard + ) {} + + ngOnInit(): void { + this.networkActive = true + this.profileService + .get() + .pipe(takeUntil(this.unsubscribeNotifier)) + .subscribe((profile) => { + this.networkActive = false + this.form.patchValue(profile) + this.currentEmail = profile.email + this.form.get('email').valueChanges.subscribe((newEmail) => { + this.newEmail = newEmail + this.onEmailChange() + }) + this.currentPassword = profile.password + this.form.get('password').valueChanges.subscribe((newPassword) => { + this.newPassword = newPassword + this.onPasswordChange() + }) + }) + } + + ngOnDestroy(): void { + this.unsubscribeNotifier.next(true) + this.unsubscribeNotifier.complete() + } + + get saveDisabled(): boolean { + return this.error?.password_confirm || this.error?.email_confirm + } + + onEmailKeyUp(event: KeyboardEvent): void { + this.newEmail = (event.target as HTMLInputElement)?.value + this.onEmailChange() + } + + onEmailConfirmKeyUp(event: KeyboardEvent): void { + this.emailConfirm = (event.target as HTMLInputElement)?.value + this.onEmailChange() + } + + onEmailChange(): void { + this.showEmailConfirm = this.currentEmail !== this.newEmail + if (this.showEmailConfirm) { + this.form.get('email_confirm').enable() + if (this.newEmail !== this.emailConfirm) { + if (!this.error) this.error = {} + this.error.email_confirm = $localize`Emails must match` + } else { + delete this.error?.email_confirm + } + } else { + this.form.get('email_confirm').disable() + delete this.error?.email_confirm + } + } + + onPasswordKeyUp(event: KeyboardEvent): void { + if ((event.target as HTMLElement).tagName !== 'input') return // toggle button can trigger this handler + this.newPassword = (event.target as HTMLInputElement)?.value + this.onPasswordChange() + } + + onPasswordConfirmKeyUp(event: KeyboardEvent): void { + this.passwordConfirm = (event.target as HTMLInputElement)?.value + this.onPasswordChange() + } + + onPasswordChange(): void { + this.showPasswordConfirm = this.currentPassword !== this.newPassword + + if (this.showPasswordConfirm) { + this.form.get('password_confirm').enable() + if (this.newPassword !== this.passwordConfirm) { + if (!this.error) this.error = {} + this.error.password_confirm = $localize`Passwords must match` + } else { + delete this.error?.password_confirm + } + } else { + this.form.get('password_confirm').disable() + delete this.error?.password_confirm + } + } + + save(): void { + const passwordChanged = this.currentPassword !== this.newPassword + const profile = Object.assign({}, this.form.value) + this.networkActive = true + this.profileService + .update(profile) + .pipe(takeUntil(this.unsubscribeNotifier)) + .subscribe({ + next: () => { + this.toastService.showInfo($localize`Profile updated successfully`) + if (passwordChanged) { + this.toastService.showInfo( + $localize`Password has been changed, you will be logged out momentarily.` + ) + setTimeout(() => { + window.location.href = `${window.location.origin}/accounts/logout/?next=/accounts/login/?next=/` + }, 2500) + } + this.activeModal.close() + }, + error: (error) => { + this.toastService.showError($localize`Error saving profile`, error) + this.networkActive = false + }, + }) + } + + cancel(): void { + this.activeModal.close() + } + + generateAuthToken(): void { + this.profileService.generateAuthToken().subscribe({ + next: (token: string) => { + this.form.patchValue({ auth_token: token }) + }, + error: (error) => { + this.toastService.showError( + $localize`Error generating auth token`, + error + ) + }, + }) + } + + copyAuthToken(): void { + this.clipboard.copy(this.form.get('auth_token').value) + this.copied = true + setTimeout(() => { + this.copied = false + }, 3000) + } +} diff --git a/src-ui/src/app/data/user-profile.ts b/src-ui/src/app/data/user-profile.ts new file mode 100644 index 000000000..94012925a --- /dev/null +++ b/src-ui/src/app/data/user-profile.ts @@ -0,0 +1,7 @@ +export interface PaperlessUserProfile { + email?: string + password?: string + first_name?: string + last_name?: string + auth_token?: string +} diff --git a/src-ui/src/app/services/profile.service.spec.ts b/src-ui/src/app/services/profile.service.spec.ts new file mode 100644 index 000000000..f19a1312e --- /dev/null +++ b/src-ui/src/app/services/profile.service.spec.ts @@ -0,0 +1,54 @@ +import { TestBed } from '@angular/core/testing' + +import { ProfileService } from './profile.service' +import { + HttpClientTestingModule, + HttpTestingController, +} from '@angular/common/http/testing' +import { environment } from 'src/environments/environment' + +describe('ProfileService', () => { + let httpTestingController: HttpTestingController + let service: ProfileService + + beforeEach(() => { + TestBed.configureTestingModule({ + providers: [ProfileService], + imports: [HttpClientTestingModule], + }) + + httpTestingController = TestBed.inject(HttpTestingController) + service = TestBed.inject(ProfileService) + }) + + afterEach(() => { + httpTestingController.verify() + }) + + it('calls get profile endpoint', () => { + service.get().subscribe() + const req = httpTestingController.expectOne( + `${environment.apiBaseUrl}profile/` + ) + expect(req.request.method).toEqual('GET') + }) + + it('calls patch on update', () => { + service.update({ email: 'foo@bar.com' }).subscribe() + const req = httpTestingController.expectOne( + `${environment.apiBaseUrl}profile/` + ) + expect(req.request.method).toEqual('PATCH') + expect(req.request.body).toEqual({ + email: 'foo@bar.com', + }) + }) + + it('supports generating new auth token', () => { + service.generateAuthToken().subscribe() + const req = httpTestingController.expectOne( + `${environment.apiBaseUrl}profile/generate_auth_token/` + ) + expect(req.request.method).toEqual('POST') + }) +}) diff --git a/src-ui/src/app/services/profile.service.ts b/src-ui/src/app/services/profile.service.ts new file mode 100644 index 000000000..de5aeb7a4 --- /dev/null +++ b/src-ui/src/app/services/profile.service.ts @@ -0,0 +1,34 @@ +import { HttpClient } from '@angular/common/http' +import { Injectable } from '@angular/core' +import { Observable } from 'rxjs' +import { PaperlessUserProfile } from '../data/user-profile' +import { environment } from 'src/environments/environment' + +@Injectable({ + providedIn: 'root', +}) +export class ProfileService { + private endpoint = 'profile' + + constructor(private http: HttpClient) {} + + get(): Observable { + return this.http.get( + `${environment.apiBaseUrl}${this.endpoint}/` + ) + } + + update(profile: PaperlessUserProfile): Observable { + return this.http.patch( + `${environment.apiBaseUrl}${this.endpoint}/`, + profile + ) + } + + generateAuthToken(): Observable { + return this.http.post( + `${environment.apiBaseUrl}${this.endpoint}/generate_auth_token/`, + {} + ) + } +} diff --git a/src/documents/tests/test_api_profile.py b/src/documents/tests/test_api_profile.py new file mode 100644 index 000000000..9e12b1ed3 --- /dev/null +++ b/src/documents/tests/test_api_profile.py @@ -0,0 +1,105 @@ +from django.contrib.auth.models import User +from rest_framework import status +from rest_framework.authtoken.models import Token +from rest_framework.test import APITestCase + +from documents.tests.utils import DirectoriesMixin + + +class TestApiProfile(DirectoriesMixin, APITestCase): + ENDPOINT = "/api/profile/" + + def setUp(self): + super().setUp() + + self.user = User.objects.create_superuser( + username="temp_admin", + first_name="firstname", + last_name="surname", + ) + self.client.force_authenticate(user=self.user) + + def test_get_profile(self): + """ + GIVEN: + - Configured user + WHEN: + - API call is made to get profile + THEN: + - Profile is returned + """ + + response = self.client.get(self.ENDPOINT) + + self.assertEqual(response.status_code, status.HTTP_200_OK) + + self.assertEqual(response.data["email"], self.user.email) + self.assertEqual(response.data["first_name"], self.user.first_name) + self.assertEqual(response.data["last_name"], self.user.last_name) + + def test_update_profile(self): + """ + GIVEN: + - Configured user + WHEN: + - API call is made to update profile + THEN: + - Profile is updated + """ + + user_data = { + "email": "new@email.com", + "password": "superpassword1234", + "first_name": "new first name", + "last_name": "new last name", + } + response = self.client.patch(self.ENDPOINT, user_data) + + self.assertEqual(response.status_code, status.HTTP_200_OK) + + user = User.objects.get(username=self.user.username) + self.assertTrue(user.check_password(user_data["password"])) + self.assertEqual(user.email, user_data["email"]) + self.assertEqual(user.first_name, user_data["first_name"]) + self.assertEqual(user.last_name, user_data["last_name"]) + + def test_update_auth_token(self): + """ + GIVEN: + - Configured user + WHEN: + - API call is made to generate auth token + THEN: + - Token is created the first time, updated the second + """ + + self.assertEqual(len(Token.objects.all()), 0) + + response = self.client.post(f"{self.ENDPOINT}generate_auth_token/") + self.assertEqual(response.status_code, status.HTTP_200_OK) + token1 = Token.objects.filter(user=self.user).first() + self.assertIsNotNone(token1) + + response = self.client.post(f"{self.ENDPOINT}generate_auth_token/") + self.assertEqual(response.status_code, status.HTTP_200_OK) + token2 = Token.objects.filter(user=self.user).first() + + self.assertNotEqual(token1.key, token2.key) + + def test_profile_not_logged_in(self): + """ + GIVEN: + - User not logged in + WHEN: + - API call is made to get profile and update token + THEN: + - Profile is returned + """ + + self.client.logout() + + response = self.client.get(self.ENDPOINT) + self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) + + response = self.client.post(f"{self.ENDPOINT}generate_auth_token/") + self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) diff --git a/src/paperless/serialisers.py b/src/paperless/serialisers.py index 4094a6538..36ba0171e 100644 --- a/src/paperless/serialisers.py +++ b/src/paperless/serialisers.py @@ -97,3 +97,19 @@ class GroupSerializer(serializers.ModelSerializer): "name", "permissions", ) + + +class ProfileSerializer(serializers.ModelSerializer): + email = serializers.EmailField(allow_null=False) + password = ObfuscatedUserPasswordField(required=False, allow_null=False) + auth_token = serializers.SlugRelatedField(read_only=True, slug_field="key") + + class Meta: + model = User + fields = ( + "email", + "password", + "first_name", + "last_name", + "auth_token", + ) diff --git a/src/paperless/urls.py b/src/paperless/urls.py index 2f0c56267..67fddbee0 100644 --- a/src/paperless/urls.py +++ b/src/paperless/urls.py @@ -35,7 +35,9 @@ from documents.views import UiSettingsView from documents.views import UnifiedSearchViewSet from paperless.consumers import StatusConsumer from paperless.views import FaviconView +from paperless.views import GenerateAuthTokenView from paperless.views import GroupViewSet +from paperless.views import ProfileView from paperless.views import UserViewSet from paperless_mail.views import MailAccountTestView from paperless_mail.views import MailAccountViewSet @@ -119,6 +121,12 @@ urlpatterns = [ BulkEditObjectPermissionsView.as_view(), name="bulk_edit_object_permissions", ), + path("profile/generate_auth_token/", GenerateAuthTokenView.as_view()), + re_path( + "^profile/", + ProfileView.as_view(), + name="profile_view", + ), *api_router.urls, ], ), diff --git a/src/paperless/views.py b/src/paperless/views.py index e872cc19c..084aee3d7 100644 --- a/src/paperless/views.py +++ b/src/paperless/views.py @@ -7,7 +7,9 @@ from django.db.models.functions import Lower from django.http import HttpResponse from django.views.generic import View from django_filters.rest_framework import DjangoFilterBackend +from rest_framework.authtoken.models import Token from rest_framework.filters import OrderingFilter +from rest_framework.generics import GenericAPIView from rest_framework.pagination import PageNumberPagination from rest_framework.permissions import IsAuthenticated from rest_framework.response import Response @@ -17,6 +19,7 @@ from documents.permissions import PaperlessObjectPermissions from paperless.filters import GroupFilterSet from paperless.filters import UserFilterSet from paperless.serialisers import GroupSerializer +from paperless.serialisers import ProfileSerializer from paperless.serialisers import UserSerializer @@ -106,3 +109,54 @@ class GroupViewSet(ModelViewSet): filter_backends = (DjangoFilterBackend, OrderingFilter) filterset_class = GroupFilterSet ordering_fields = ("name",) + + +class ProfileView(GenericAPIView): + """ + User profile view, only available when logged in + """ + + permission_classes = [IsAuthenticated] + serializer_class = ProfileSerializer + + def get(self, request, *args, **kwargs): + user = self.request.user + + serializer = self.get_serializer(data=request.data) + return Response(serializer.to_representation(user)) + + def patch(self, request, *args, **kwargs): + serializer = self.get_serializer(data=request.data) + serializer.is_valid(raise_exception=True) + user = self.request.user if hasattr(self.request, "user") else None + + if len(serializer.validated_data.get("password").replace("*", "")) > 0: + user.set_password(serializer.validated_data.get("password")) + user.save() + serializer.validated_data.pop("password") + + for key, value in serializer.validated_data.items(): + setattr(user, key, value) + user.save() + + return Response(serializer.to_representation(user)) + + +class GenerateAuthTokenView(GenericAPIView): + """ + Generates (or re-generates) an auth token, requires a logged in user + unlike the default DRF endpoint + """ + + permission_classes = [IsAuthenticated] + + def post(self, request, *args, **kwargs): + user = self.request.user + + existing_token = Token.objects.filter(user=user).first() + if existing_token is not None: + existing_token.delete() + token = Token.objects.create(user=user) + return Response( + token.key, + )