diff --git a/src-ui/setup-jest.ts b/src-ui/setup-jest.ts
index 8e754589b..3486d17fc 100644
--- a/src-ui/setup-jest.ts
+++ b/src-ui/setup-jest.ts
@@ -85,6 +85,7 @@ const mock = () => {
}
}
+Object.defineProperty(window, 'open', { value: jest.fn() })
Object.defineProperty(window, 'localStorage', { value: mock() })
Object.defineProperty(window, 'sessionStorage', { value: mock() })
Object.defineProperty(window, 'getComputedStyle', {
diff --git a/src-ui/src/app/app.component.spec.ts b/src-ui/src/app/app.component.spec.ts
index 80fbdfa5f..e5fac4cc5 100644
--- a/src-ui/src/app/app.component.spec.ts
+++ b/src-ui/src/app/app.component.spec.ts
@@ -5,8 +5,7 @@ import {
fakeAsync,
tick,
} from '@angular/core/testing'
-import { Router } from '@angular/router'
-import { RouterTestingModule } from '@angular/router/testing'
+import { Router, RouterModule } from '@angular/router'
import { TourService, TourNgBootstrapModule } from 'ngx-ui-tour-ng-bootstrap'
import { Subject } from 'rxjs'
import { routes } from './app-routing.module'
@@ -21,6 +20,10 @@ import { ToastService, Toast } from './services/toast.service'
import { SettingsService } from './services/settings.service'
import { FileDropComponent } from './components/file-drop/file-drop.component'
import { NgxFileDropModule } from 'ngx-file-drop'
+import { NgbModalModule } from '@ng-bootstrap/ng-bootstrap'
+import { HotKeyService } from './services/hot-key.service'
+import { PermissionsGuard } from './guards/permissions.guard'
+import { DirtySavedViewGuard } from './guards/dirty-saved-view.guard'
describe('AppComponent', () => {
let component: AppComponent
@@ -31,16 +34,18 @@ describe('AppComponent', () => {
let toastService: ToastService
let router: Router
let settingsService: SettingsService
+ let hotKeyService: HotKeyService
beforeEach(async () => {
TestBed.configureTestingModule({
declarations: [AppComponent, ToastsComponent, FileDropComponent],
- providers: [],
+ providers: [PermissionsGuard, DirtySavedViewGuard],
imports: [
HttpClientTestingModule,
TourNgBootstrapModule,
- RouterTestingModule.withRoutes(routes),
+ RouterModule.forRoot(routes),
NgxFileDropModule,
+ NgbModalModule,
],
}).compileComponents()
@@ -50,6 +55,7 @@ describe('AppComponent', () => {
settingsService = TestBed.inject(SettingsService)
toastService = TestBed.inject(ToastService)
router = TestBed.inject(Router)
+ hotKeyService = TestBed.inject(HotKeyService)
fixture = TestBed.createComponent(AppComponent)
component = fixture.componentInstance
})
@@ -139,4 +145,20 @@ describe('AppComponent', () => {
fileStatusSubject.next(new FileStatus())
expect(toastSpy).toHaveBeenCalled()
})
+
+ it('should support hotkeys', () => {
+ const addShortcutSpy = jest.spyOn(hotKeyService, 'addShortcut')
+ const routerSpy = jest.spyOn(router, 'navigate')
+ // prevent actual navigation
+ routerSpy.mockReturnValue(new Promise(() => {}))
+ jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
+ component.ngOnInit()
+ expect(addShortcutSpy).toHaveBeenCalled()
+ document.dispatchEvent(new KeyboardEvent('keydown', { key: 'h' }))
+ expect(routerSpy).toHaveBeenCalledWith(['/dashboard'])
+ document.dispatchEvent(new KeyboardEvent('keydown', { key: 'd' }))
+ expect(routerSpy).toHaveBeenCalledWith(['/documents'])
+ document.dispatchEvent(new KeyboardEvent('keydown', { key: 's' }))
+ expect(routerSpy).toHaveBeenCalledWith(['/settings'])
+ })
})
diff --git a/src-ui/src/app/app.component.ts b/src-ui/src/app/app.component.ts
index e93fde30c..7e8abdf34 100644
--- a/src-ui/src/app/app.component.ts
+++ b/src-ui/src/app/app.component.ts
@@ -12,6 +12,7 @@ import {
PermissionsService,
PermissionType,
} from './services/permissions.service'
+import { HotKeyService } from './services/hot-key.service'
@Component({
selector: 'pngx-root',
@@ -31,7 +32,8 @@ export class AppComponent implements OnInit, OnDestroy {
private tasksService: TasksService,
public tourService: TourService,
private renderer: Renderer2,
- private permissionsService: PermissionsService
+ private permissionsService: PermissionsService,
+ private hotKeyService: HotKeyService
) {
this.settings.updateAppearanceSettings()
}
@@ -123,6 +125,36 @@ export class AppComponent implements OnInit, OnDestroy {
}
})
+ this.hotKeyService
+ .addShortcut({ keys: 'h', description: $localize`Dashboard` })
+ .subscribe(() => {
+ this.router.navigate(['/dashboard'])
+ })
+ if (
+ this.permissionsService.currentUserCan(
+ PermissionAction.View,
+ PermissionType.Document
+ )
+ ) {
+ this.hotKeyService
+ .addShortcut({ keys: 'd', description: $localize`Documents` })
+ .subscribe(() => {
+ this.router.navigate(['/documents'])
+ })
+ }
+ if (
+ this.permissionsService.currentUserCan(
+ PermissionAction.Change,
+ PermissionType.UISettings
+ )
+ ) {
+ this.hotKeyService
+ .addShortcut({ keys: 's', description: $localize`Settings` })
+ .subscribe(() => {
+ this.router.navigate(['/settings'])
+ })
+ }
+
const prevBtnTitle = $localize`Prev`
const nextBtnTitle = $localize`Next`
const endBtnTitle = $localize`End`
diff --git a/src-ui/src/app/app.module.ts b/src-ui/src/app/app.module.ts
index 416cfd129..24d63ed11 100644
--- a/src-ui/src/app/app.module.ts
+++ b/src-ui/src/app/app.module.ts
@@ -122,6 +122,8 @@ import { SplitConfirmDialogComponent } from './components/common/confirm-dialog/
import { DocumentHistoryComponent } from './components/document-history/document-history.component'
import { DragDropSelectComponent } from './components/common/input/drag-drop-select/drag-drop-select.component'
import { CustomFieldDisplayComponent } from './components/common/custom-field-display/custom-field-display.component'
+import { GlobalSearchComponent } from './components/app-frame/global-search/global-search.component'
+import { HotkeyDialogComponent } from './components/common/hotkey-dialog/hotkey-dialog.component'
import {
airplane,
archive,
@@ -163,6 +165,7 @@ import {
doorOpen,
download,
envelope,
+ envelopeAt,
exclamationCircleFill,
exclamationTriangle,
exclamationTriangleFill,
@@ -196,6 +199,7 @@ import {
personFill,
personFillLock,
personLock,
+ personSquare,
plus,
plusCircle,
questionCircle,
@@ -206,6 +210,7 @@ import {
sortAlphaDown,
sortAlphaUpAlt,
tagFill,
+ tag,
tags,
textIndentLeft,
textLeft,
@@ -259,6 +264,7 @@ const icons = {
doorOpen,
download,
envelope,
+ envelopeAt,
exclamationCircleFill,
exclamationTriangle,
exclamationTriangleFill,
@@ -292,6 +298,7 @@ const icons = {
personFill,
personFillLock,
personLock,
+ personSquare,
plus,
plusCircle,
questionCircle,
@@ -302,6 +309,7 @@ const icons = {
sortAlphaDown,
sortAlphaUpAlt,
tagFill,
+ tag,
tags,
textIndentLeft,
textLeft,
@@ -482,6 +490,8 @@ function initializeApp(settings: SettingsService) {
DocumentHistoryComponent,
DragDropSelectComponent,
CustomFieldDisplayComponent,
+ GlobalSearchComponent,
+ HotkeyDialogComponent,
],
imports: [
BrowserModule,
diff --git a/src-ui/src/app/components/admin/settings/settings.component.html b/src-ui/src/app/components/admin/settings/settings.component.html
index b5c6ca6b4..87d7ba68a 100644
--- a/src-ui/src/app/components/admin/settings/settings.component.html
+++ b/src-ui/src/app/components/admin/settings/settings.component.html
@@ -197,6 +197,14 @@
+ Global search
+
+
+
Notes
diff --git a/src-ui/src/app/components/admin/settings/settings.component.spec.ts b/src-ui/src/app/components/admin/settings/settings.component.spec.ts
index 7b23edc21..71778d394 100644
--- a/src-ui/src/app/components/admin/settings/settings.component.spec.ts
+++ b/src-ui/src/app/components/admin/settings/settings.component.spec.ts
@@ -309,7 +309,7 @@ describe('SettingsComponent', () => {
expect(toastErrorSpy).toHaveBeenCalled()
expect(storeSpy).toHaveBeenCalled()
expect(appearanceSettingsSpy).not.toHaveBeenCalled()
- expect(setSpy).toHaveBeenCalledTimes(25)
+ expect(setSpy).toHaveBeenCalledTimes(26)
// succeed
storeSpy.mockReturnValueOnce(of(true))
diff --git a/src-ui/src/app/components/admin/settings/settings.component.ts b/src-ui/src/app/components/admin/settings/settings.component.ts
index 7df90e3de..036f27f48 100644
--- a/src-ui/src/app/components/admin/settings/settings.component.ts
+++ b/src-ui/src/app/components/admin/settings/settings.component.ts
@@ -100,6 +100,7 @@ export class SettingsComponent
defaultPermsEditUsers: new FormControl(null),
defaultPermsEditGroups: new FormControl(null),
documentEditingRemoveInboxTags: new FormControl(null),
+ searchDbOnly: new FormControl(null),
notificationsConsumerNewDocument: new FormControl(null),
notificationsConsumerSuccess: new FormControl(null),
@@ -304,6 +305,7 @@ export class SettingsComponent
documentEditingRemoveInboxTags: this.settings.get(
SETTINGS_KEYS.DOCUMENT_EDITING_REMOVE_INBOX_TAGS
),
+ searchDbOnly: this.settings.get(SETTINGS_KEYS.SEARCH_DB_ONLY),
savedViews: {},
}
}
@@ -533,6 +535,10 @@ export class SettingsComponent
SETTINGS_KEYS.DOCUMENT_EDITING_REMOVE_INBOX_TAGS,
this.settingsForm.value.documentEditingRemoveInboxTags
)
+ this.settings.set(
+ SETTINGS_KEYS.SEARCH_DB_ONLY,
+ this.settingsForm.value.searchDbOnly
+ )
this.settings.setLanguage(this.settingsForm.value.displayLanguage)
this.settings
.storeSettings()
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 1e4080c48..ab5759ec0 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
@@ -24,19 +24,10 @@
}
-
@@ -38,7 +44,9 @@
(selectionModelChange)="updateRules()"
(opened)="onTagsDropdownOpen()"
[documentCounts]="tagDocumentCounts"
- [allowSelectNone]="true">
+ [allowSelectNone]="true"
+ [disabled]="disabled"
+ shortcutKey="t">
}
@if (permissionsService.currentUserCan(PermissionAction.View, PermissionType.Correspondent)) {
+ [allowSelectNone]="true"
+ [disabled]="disabled"
+ shortcutKey="y">
}
@if (permissionsService.currentUserCan(PermissionAction.View, PermissionType.DocumentType)) {
+ [allowSelectNone]="true"
+ [disabled]="disabled"
+ shortcutKey="u">
}
@if (permissionsService.currentUserCan(PermissionAction.View, PermissionType.StoragePath) && storagePaths.length > 0) {
+ [allowSelectNone]="true"
+ [disabled]="disabled"
+ shortcutKey="i">
}
@if (permissionsService.currentUserCan(PermissionAction.View, PermissionType.CustomField) && customFields.length > 0) {
diff --git a/src-ui/src/app/components/document-list/filter-editor/filter-editor.component.spec.ts b/src-ui/src/app/components/document-list/filter-editor/filter-editor.component.spec.ts
index f52907bf2..0fcbbc299 100644
--- a/src-ui/src/app/components/document-list/filter-editor/filter-editor.component.spec.ts
+++ b/src-ui/src/app/components/document-list/filter-editor/filter-editor.component.spec.ts
@@ -11,14 +11,14 @@ import {
} from '@angular/core/testing'
import { FormsModule, ReactiveFormsModule } from '@angular/forms'
import { By } from '@angular/platform-browser'
-import { RouterTestingModule } from '@angular/router/testing'
import {
NgbDropdownModule,
NgbDatepickerModule,
NgbDropdownItem,
+ NgbTypeaheadModule,
} from '@ng-bootstrap/ng-bootstrap'
import { NgSelectComponent } from '@ng-select/ng-select'
-import { of } from 'rxjs'
+import { of, throwError } from 'rxjs'
import {
FILTER_TITLE,
FILTER_TITLE_CONTENT,
@@ -92,6 +92,8 @@ import {
import { environment } from 'src/environments/environment'
import { CustomField, CustomFieldDataType } from 'src/app/data/custom-field'
import { CustomFieldsService } from 'src/app/services/rest/custom-fields.service'
+import { RouterModule } from '@angular/router'
+import { SearchService } from 'src/app/services/rest/search.service'
const tags: Tag[] = [
{
@@ -164,6 +166,7 @@ describe('FilterEditorComponent', () => {
let settingsService: SettingsService
let permissionsService: PermissionsService
let httpTestingController: HttpTestingController
+ let searchService: SearchService
beforeEach(fakeAsync(() => {
TestBed.configureTestingModule({
@@ -222,12 +225,13 @@ describe('FilterEditorComponent', () => {
],
imports: [
HttpClientTestingModule,
- RouterTestingModule,
+ RouterModule,
NgbDropdownModule,
FormsModule,
ReactiveFormsModule,
NgbDatepickerModule,
NgxBootstrapIconsModule.pick(allIcons),
+ NgbTypeaheadModule,
],
}).compileComponents()
@@ -235,6 +239,7 @@ describe('FilterEditorComponent', () => {
settingsService = TestBed.inject(SettingsService)
settingsService.currentUser = users[0]
permissionsService = TestBed.inject(PermissionsService)
+ searchService = TestBed.inject(SearchService)
jest
.spyOn(permissionsService, 'currentUserCan')
.mockImplementation((action, type) => {
@@ -2034,6 +2039,11 @@ describe('FilterEditorComponent', () => {
new KeyboardEvent('keyup', { key: 'Escape' })
)
expect(component.textFilter).toEqual('')
+ const blurSpy = jest.spyOn(component.textFilterInput.nativeElement, 'blur')
+ component.textFilterInput.nativeElement.dispatchEvent(
+ new KeyboardEvent('keyup', { key: 'Escape' })
+ )
+ expect(blurSpy).toHaveBeenCalled()
})
it('should adjust text filter targets if more like search', () => {
@@ -2044,4 +2054,40 @@ describe('FilterEditorComponent', () => {
name: $localize`More like`,
})
})
+
+ it('should call autocomplete endpoint on input', fakeAsync(() => {
+ component.textFilterTarget = 'fulltext-query' // TEXT_FILTER_TARGET_FULLTEXT_QUERY
+ const autocompleteSpy = jest.spyOn(searchService, 'autocomplete')
+ component.searchAutoComplete(of('hello')).subscribe()
+ tick(250)
+ expect(autocompleteSpy).toHaveBeenCalled()
+
+ component.searchAutoComplete(of('hello world 1')).subscribe()
+ tick(250)
+ expect(autocompleteSpy).toHaveBeenCalled()
+ }))
+
+ it('should handle autocomplete backend failure gracefully', fakeAsync(() => {
+ component.textFilterTarget = 'fulltext-query' // TEXT_FILTER_TARGET_FULLTEXT_QUERY
+ const serviceAutocompleteSpy = jest.spyOn(searchService, 'autocomplete')
+ serviceAutocompleteSpy.mockReturnValue(
+ throwError(() => new Error('autcomplete failed'))
+ )
+ // serviceAutocompleteSpy.mockReturnValue(of([' world']))
+ let result
+ component.searchAutoComplete(of('hello')).subscribe((res) => {
+ result = res
+ })
+ tick(250)
+ expect(serviceAutocompleteSpy).toHaveBeenCalled()
+ expect(result).toEqual([])
+ }))
+
+ it('should support choosing a autocomplete item', () => {
+ expect(component.textFilter).toBeNull()
+ component.itemSelected({ item: 'hello', preventDefault: () => true })
+ expect(component.textFilter).toEqual('hello ')
+ component.itemSelected({ item: 'world', preventDefault: () => true })
+ expect(component.textFilter).toEqual('hello world ')
+ })
})
diff --git a/src-ui/src/app/components/document-list/filter-editor/filter-editor.component.ts b/src-ui/src/app/components/document-list/filter-editor/filter-editor.component.ts
index b59ae53f1..994de01f0 100644
--- a/src-ui/src/app/components/document-list/filter-editor/filter-editor.component.ts
+++ b/src-ui/src/app/components/document-list/filter-editor/filter-editor.component.ts
@@ -7,12 +7,21 @@ import {
OnDestroy,
ViewChild,
ElementRef,
+ AfterViewInit,
} from '@angular/core'
import { Tag } from 'src/app/data/tag'
import { Correspondent } from 'src/app/data/correspondent'
import { DocumentType } from 'src/app/data/document-type'
-import { Subject, Subscription } from 'rxjs'
-import { debounceTime, distinctUntilChanged, filter } from 'rxjs/operators'
+import { Observable, Subject, Subscription, from } from 'rxjs'
+import {
+ catchError,
+ debounceTime,
+ distinctUntilChanged,
+ filter,
+ map,
+ switchMap,
+ takeUntil,
+} from 'rxjs/operators'
import { DocumentTypeService } from 'src/app/services/rest/document-type.service'
import { TagService } from 'src/app/services/rest/tag.service'
import { CorrespondentService } from 'src/app/services/rest/correspondent.service'
@@ -82,6 +91,7 @@ import {
import { ComponentWithPermissions } from '../../with-permissions/with-permissions.component'
import { CustomFieldsService } from 'src/app/services/rest/custom-fields.service'
import { CustomField } from 'src/app/data/custom-field'
+import { SearchService } from 'src/app/services/rest/search.service'
const TEXT_FILTER_TARGET_TITLE = 'title'
const TEXT_FILTER_TARGET_TITLE_CONTENT = 'title-content'
@@ -169,7 +179,7 @@ const DEFAULT_TEXT_FILTER_MODIFIER_OPTIONS = [
})
export class FilterEditorComponent
extends ComponentWithPermissions
- implements OnInit, OnDestroy
+ implements OnInit, OnDestroy, AfterViewInit
{
generateFilterName() {
if (this.filterRules.length == 1) {
@@ -251,7 +261,8 @@ export class FilterEditorComponent
private documentService: DocumentService,
private storagePathService: StoragePathService,
public permissionsService: PermissionsService,
- private customFieldService: CustomFieldsService
+ private customFieldService: CustomFieldsService,
+ private searchService: SearchService
) {
super()
}
@@ -275,6 +286,8 @@ export class FilterEditorComponent
_moreLikeId: number
_moreLikeDoc: Document
+ unsubscribeNotifier: Subject = new Subject()
+
get textFilterTargets() {
if (this.textFilterTarget == TEXT_FILTER_TARGET_FULLTEXT_MORELIKE) {
return DEFAULT_TEXT_FILTER_TARGET_OPTIONS.concat([
@@ -944,7 +957,9 @@ export class FilterEditorComponent
}
textFilterDebounce: Subject
- subscription: Subscription
+
+ @Input()
+ public disabled: boolean = false
ngOnInit() {
if (
@@ -1000,19 +1015,29 @@ export class FilterEditorComponent
this.textFilterDebounce = new Subject()
- this.subscription = this.textFilterDebounce
+ this.textFilterDebounce
.pipe(
+ takeUntil(this.unsubscribeNotifier),
debounceTime(400),
distinctUntilChanged(),
filter((query) => !query.length || query.length > 2)
)
- .subscribe((text) => this.updateTextFilter(text))
+ .subscribe((text) =>
+ this.updateTextFilter(
+ text,
+ this.textFilterTarget !== TEXT_FILTER_TARGET_FULLTEXT_QUERY
+ )
+ )
if (this._textFilter) this.documentService.searchQuery = this._textFilter
}
+ ngAfterViewInit() {
+ this.textFilterInput.nativeElement.focus()
+ }
+
ngOnDestroy() {
- this.textFilterDebounce.complete()
+ this.unsubscribeNotifier.next(true)
}
resetSelected() {
@@ -1057,10 +1082,12 @@ export class FilterEditorComponent
this.customFieldSelectionModel.apply()
}
- updateTextFilter(text) {
+ updateTextFilter(text, updateRules = true) {
this._textFilter = text
- this.documentService.searchQuery = text
- this.updateRules()
+ if (updateRules) {
+ this.documentService.searchQuery = text
+ this.updateRules()
+ }
}
textFilterKeyup(event: KeyboardEvent) {
@@ -1071,8 +1098,12 @@ export class FilterEditorComponent
if (filterString.length) {
this.updateTextFilter(filterString)
}
- } else if (event.key == 'Escape') {
- this.resetTextField()
+ } else if (event.key === 'Escape') {
+ if (this._textFilter?.length) {
+ this.resetTextField()
+ } else {
+ this.textFilterInput.nativeElement.blur()
+ }
}
}
@@ -1105,4 +1136,40 @@ export class FilterEditorComponent
this.updateRules()
}
}
+
+ searchAutoComplete = (text$: Observable) =>
+ text$.pipe(
+ debounceTime(200),
+ distinctUntilChanged(),
+ filter(() => this.textFilterTarget === TEXT_FILTER_TARGET_FULLTEXT_QUERY),
+ map((term) => {
+ if (term.lastIndexOf(' ') != -1) {
+ return term.substring(term.lastIndexOf(' ') + 1)
+ } else {
+ return term
+ }
+ }),
+ switchMap((term) =>
+ term.length < 2
+ ? from([[]])
+ : this.searchService.autocomplete(term).pipe(
+ catchError(() => {
+ return from([[]])
+ })
+ )
+ )
+ )
+
+ itemSelected(event) {
+ event.preventDefault()
+ let currentSearch: string = this._textFilter ?? ''
+ let lastSpaceIndex = currentSearch.lastIndexOf(' ')
+ if (lastSpaceIndex != -1) {
+ currentSearch = currentSearch.substring(0, lastSpaceIndex + 1)
+ currentSearch += event.item + ' '
+ } else {
+ currentSearch = event.item + ' '
+ }
+ this.updateTextFilter(currentSearch)
+ }
}
diff --git a/src-ui/src/app/data/datatype.ts b/src-ui/src/app/data/datatype.ts
new file mode 100644
index 000000000..288186c52
--- /dev/null
+++ b/src-ui/src/app/data/datatype.ts
@@ -0,0 +1,14 @@
+export enum DataType {
+ Document = 'document',
+ SavedView = 'saved_view',
+ Correspondent = 'correspondent',
+ DocumentType = 'document_type',
+ StoragePath = 'storage_path',
+ Tag = 'tag',
+ User = 'user',
+ Group = 'group',
+ MailAccount = 'mail_account',
+ MailRule = 'mail_rule',
+ CustomField = 'custom_field',
+ Workflow = 'workflow',
+}
diff --git a/src-ui/src/app/data/filter-rule-type.ts b/src-ui/src/app/data/filter-rule-type.ts
index cd4700096..9a87a421c 100644
--- a/src-ui/src/app/data/filter-rule-type.ts
+++ b/src-ui/src/app/data/filter-rule-type.ts
@@ -1,3 +1,5 @@
+import { DataType } from './datatype'
+
// These correspond to src/documents/models.py and changes here require a DB migration (and vice versa)
export const FILTER_TITLE = 0
export const FILTER_CONTENT = 1
@@ -78,57 +80,57 @@ export const FILTER_RULE_TYPES: FilterRuleType[] = [
id: FILTER_CORRESPONDENT,
filtervar: 'correspondent__id',
isnull_filtervar: 'correspondent__isnull',
- datatype: 'correspondent',
+ datatype: DataType.Correspondent,
multi: false,
},
{
id: FILTER_HAS_CORRESPONDENT_ANY,
filtervar: 'correspondent__id__in',
- datatype: 'correspondent',
+ datatype: DataType.Correspondent,
multi: true,
},
{
id: FILTER_DOES_NOT_HAVE_CORRESPONDENT,
filtervar: 'correspondent__id__none',
- datatype: 'correspondent',
+ datatype: DataType.Correspondent,
multi: true,
},
{
id: FILTER_STORAGE_PATH,
filtervar: 'storage_path__id',
isnull_filtervar: 'storage_path__isnull',
- datatype: 'storage_path',
+ datatype: DataType.StoragePath,
multi: false,
},
{
id: FILTER_HAS_STORAGE_PATH_ANY,
filtervar: 'storage_path__id__in',
- datatype: 'storage_path',
+ datatype: DataType.StoragePath,
multi: true,
},
{
id: FILTER_DOES_NOT_HAVE_STORAGE_PATH,
filtervar: 'storage_path__id__none',
- datatype: 'storage_path',
+ datatype: DataType.StoragePath,
multi: true,
},
{
id: FILTER_DOCUMENT_TYPE,
filtervar: 'document_type__id',
isnull_filtervar: 'document_type__isnull',
- datatype: 'document_type',
+ datatype: DataType.DocumentType,
multi: false,
},
{
id: FILTER_HAS_DOCUMENT_TYPE_ANY,
filtervar: 'document_type__id__in',
- datatype: 'document_type',
+ datatype: DataType.DocumentType,
multi: true,
},
{
id: FILTER_DOES_NOT_HAVE_DOCUMENT_TYPE,
filtervar: 'document_type__id__none',
- datatype: 'document_type',
+ datatype: DataType.DocumentType,
multi: true,
},
{
@@ -141,19 +143,19 @@ export const FILTER_RULE_TYPES: FilterRuleType[] = [
{
id: FILTER_HAS_TAGS_ALL,
filtervar: 'tags__id__all',
- datatype: 'tag',
+ datatype: DataType.Tag,
multi: true,
},
{
id: FILTER_HAS_TAGS_ANY,
filtervar: 'tags__id__in',
- datatype: 'tag',
+ datatype: DataType.Tag,
multi: true,
},
{
id: FILTER_DOES_NOT_HAVE_TAG,
filtervar: 'tags__id__none',
- datatype: 'tag',
+ datatype: DataType.Tag,
multi: true,
},
{
diff --git a/src-ui/src/app/data/ui-settings.ts b/src-ui/src/app/data/ui-settings.ts
index 41f9ba361..6f8f246ff 100644
--- a/src-ui/src/app/data/ui-settings.ts
+++ b/src-ui/src/app/data/ui-settings.ts
@@ -56,6 +56,7 @@ export const SETTINGS_KEYS = {
DEFAULT_PERMS_EDIT_GROUPS: 'general-settings:permissions:default-edit-groups',
DOCUMENT_EDITING_REMOVE_INBOX_TAGS:
'general-settings:document-editing:remove-inbox-tags',
+ SEARCH_DB_ONLY: 'general-settings:search:db-only',
}
export const SETTINGS: UiSetting[] = [
@@ -219,4 +220,9 @@ export const SETTINGS: UiSetting[] = [
type: 'boolean',
default: false,
},
+ {
+ key: SETTINGS_KEYS.SEARCH_DB_ONLY,
+ type: 'boolean',
+ default: false,
+ },
]
diff --git a/src-ui/src/app/services/hot-key.service.spec.ts b/src-ui/src/app/services/hot-key.service.spec.ts
new file mode 100644
index 000000000..d23293c59
--- /dev/null
+++ b/src-ui/src/app/services/hot-key.service.spec.ts
@@ -0,0 +1,99 @@
+import { TestBed } from '@angular/core/testing'
+import { EventManager } from '@angular/platform-browser'
+import { DOCUMENT } from '@angular/common'
+
+import { HotKeyService } from './hot-key.service'
+import { NgbModal, NgbModalModule } from '@ng-bootstrap/ng-bootstrap'
+
+describe('HotKeyService', () => {
+ let service: HotKeyService
+ let eventManager: EventManager
+ let document: Document
+ let modalService: NgbModal
+
+ beforeEach(() => {
+ TestBed.configureTestingModule({
+ providers: [HotKeyService, EventManager],
+ imports: [NgbModalModule],
+ })
+ service = TestBed.inject(HotKeyService)
+ eventManager = TestBed.inject(EventManager)
+ document = TestBed.inject(DOCUMENT)
+ modalService = TestBed.inject(NgbModal)
+ })
+
+ it('should support adding a shortcut', () => {
+ const callback = jest.fn()
+ const addEventListenerSpy = jest.spyOn(eventManager, 'addEventListener')
+
+ const observable = service
+ .addShortcut({ keys: 'control.a' })
+ .subscribe(() => {
+ callback()
+ })
+
+ expect(addEventListenerSpy).toHaveBeenCalled()
+
+ document.dispatchEvent(
+ new KeyboardEvent('keydown', { key: 'a', ctrlKey: true })
+ )
+ expect(callback).toHaveBeenCalled()
+
+ //coverage
+ observable.unsubscribe()
+ })
+
+ it('should support adding a shortcut with a description, show modal', () => {
+ const addEventListenerSpy = jest.spyOn(eventManager, 'addEventListener')
+ service
+ .addShortcut({ keys: 'control.a', description: 'Select all' })
+ .subscribe()
+ expect(addEventListenerSpy).toHaveBeenCalled()
+ const modalSpy = jest.spyOn(modalService, 'open')
+ document.dispatchEvent(
+ new KeyboardEvent('keydown', { key: '?', shiftKey: true })
+ )
+ expect(modalSpy).toHaveBeenCalled()
+ })
+
+ it('should ignore keydown events from input elements that dont have a modifier key', () => {
+ // constructor adds a shortcut for shift.?
+ const modalSpy = jest.spyOn(modalService, 'open')
+ const input = document.createElement('input')
+ const textArea = document.createElement('textarea')
+ const event = new KeyboardEvent('keydown', { key: '?', shiftKey: true })
+ jest.spyOn(event, 'target', 'get').mockReturnValue(input)
+ document.dispatchEvent(event)
+ jest.spyOn(event, 'target', 'get').mockReturnValue(textArea)
+ document.dispatchEvent(event)
+ expect(modalSpy).not.toHaveBeenCalled()
+ })
+
+ it('should dismiss all modals on escape and not fire event', () => {
+ const callback = jest.fn()
+ service
+ .addShortcut({ keys: 'escape', description: 'Escape' })
+ .subscribe(callback)
+ const modalSpy = jest.spyOn(modalService, 'open')
+ document.dispatchEvent(
+ new KeyboardEvent('keydown', { key: '?', shiftKey: true })
+ )
+ expect(modalSpy).toHaveBeenCalled()
+ const dismissAllSpy = jest.spyOn(modalService, 'dismissAll')
+ document.dispatchEvent(new KeyboardEvent('keydown', { key: 'Escape' }))
+ expect(dismissAllSpy).toHaveBeenCalled()
+ expect(callback).not.toHaveBeenCalled()
+ })
+
+ it('should not fire event on escape when open dropdowns ', () => {
+ const callback = jest.fn()
+ service
+ .addShortcut({ keys: 'escape', description: 'Escape' })
+ .subscribe(callback)
+ const dropdown = document.createElement('div')
+ dropdown.classList.add('dropdown-menu', 'show')
+ document.body.appendChild(dropdown)
+ document.dispatchEvent(new KeyboardEvent('keydown', { key: 'Escape' }))
+ expect(callback).not.toHaveBeenCalled()
+ })
+})
diff --git a/src-ui/src/app/services/hot-key.service.ts b/src-ui/src/app/services/hot-key.service.ts
new file mode 100644
index 000000000..22a757581
--- /dev/null
+++ b/src-ui/src/app/services/hot-key.service.ts
@@ -0,0 +1,98 @@
+import { DOCUMENT } from '@angular/common'
+import { Inject, Injectable } from '@angular/core'
+import { EventManager } from '@angular/platform-browser'
+import { NgbModal } from '@ng-bootstrap/ng-bootstrap'
+import { Observable } from 'rxjs'
+import { HotkeyDialogComponent } from '../components/common/hotkey-dialog/hotkey-dialog.component'
+
+export interface ShortcutOptions {
+ element?: any
+ keys: string
+ description?: string
+}
+
+@Injectable({
+ providedIn: 'root',
+})
+export class HotKeyService {
+ private defaults: Partial = {
+ element: this.document,
+ }
+
+ private hotkeys: Map = new Map()
+
+ constructor(
+ private eventManager: EventManager,
+ @Inject(DOCUMENT) private document: Document,
+ private modalService: NgbModal
+ ) {
+ this.addShortcut({ keys: 'shift.?' }).subscribe(() => {
+ this.openHelpModal()
+ })
+ }
+
+ public addShortcut(options: ShortcutOptions) {
+ const optionsWithDefaults = { ...this.defaults, ...options }
+ const event = `keydown.${optionsWithDefaults.keys}`
+
+ if (optionsWithDefaults.description) {
+ this.hotkeys.set(
+ optionsWithDefaults.keys,
+ optionsWithDefaults.description
+ )
+ }
+
+ return new Observable((observer) => {
+ const handler = (e: KeyboardEvent) => {
+ if (
+ !(e.altKey || e.metaKey || e.ctrlKey) &&
+ (e.target instanceof HTMLInputElement ||
+ e.target instanceof HTMLTextAreaElement)
+ ) {
+ // Ignore keydown events from input elements that dont have a modifier key
+ return
+ }
+
+ this.modalService.dismissAll()
+ if (
+ e.key === 'Escape' &&
+ (this.modalService.hasOpenModals() ||
+ this.document.getElementsByClassName('dropdown-menu show').length >
+ 0)
+ ) {
+ // If there is a modal open or menu open, ignore the keydown event
+ return
+ }
+
+ e.preventDefault()
+ observer.next(e)
+ }
+
+ const dispose = this.eventManager.addEventListener(
+ optionsWithDefaults.element,
+ event,
+ handler
+ )
+
+ let disposeMeta
+ if (event.includes('control')) {
+ disposeMeta = this.eventManager.addEventListener(
+ optionsWithDefaults.element,
+ event.replace('control', 'meta'),
+ handler
+ )
+ }
+
+ return () => {
+ dispose()
+ if (disposeMeta) disposeMeta()
+ this.hotkeys.delete(optionsWithDefaults.keys)
+ }
+ })
+ }
+
+ private openHelpModal() {
+ const modal = this.modalService.open(HotkeyDialogComponent)
+ modal.componentInstance.hotkeys = this.hotkeys
+ }
+}
diff --git a/src-ui/src/app/services/open-documents.service.spec.ts b/src-ui/src/app/services/open-documents.service.spec.ts
index 09341da62..21d5d91a8 100644
--- a/src-ui/src/app/services/open-documents.service.spec.ts
+++ b/src-ui/src/app/services/open-documents.service.spec.ts
@@ -135,6 +135,7 @@ describe('OpenDocumentsService', () => {
expect(openDocumentsService.hasDirty()).toBeFalsy()
openDocumentsService.setDirty(documents[0], true)
expect(openDocumentsService.hasDirty()).toBeTruthy()
+ expect(openDocumentsService.isDirty(documents[0])).toBeTruthy()
let openModal
modalService.activeInstances.subscribe((instances) => {
openModal = instances[0]
diff --git a/src-ui/src/app/services/open-documents.service.ts b/src-ui/src/app/services/open-documents.service.ts
index 363a51b03..33e98ce12 100644
--- a/src-ui/src/app/services/open-documents.service.ts
+++ b/src-ui/src/app/services/open-documents.service.ts
@@ -90,6 +90,10 @@ export class OpenDocumentsService {
return this.dirtyDocuments.size > 0
}
+ isDirty(doc: Document): boolean {
+ return this.dirtyDocuments.has(doc.id)
+ }
+
closeDocument(doc: Document): Observable {
let index = this.openDocuments.findIndex((d) => d.id == doc.id)
if (index == -1) return of(true)
diff --git a/src-ui/src/app/services/rest/search.service.spec.ts b/src-ui/src/app/services/rest/search.service.spec.ts
index 7f42aa7da..346b8a092 100644
--- a/src-ui/src/app/services/rest/search.service.spec.ts
+++ b/src-ui/src/app/services/rest/search.service.spec.ts
@@ -6,10 +6,13 @@ import { Subscription } from 'rxjs'
import { TestBed } from '@angular/core/testing'
import { environment } from 'src/environments/environment'
import { SearchService } from './search.service'
+import { SettingsService } from '../settings.service'
+import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
let httpTestingController: HttpTestingController
let service: SearchService
let subscription: Subscription
+let settingsService: SettingsService
const endpoint = 'search/autocomplete'
describe('SearchService', () => {
@@ -20,6 +23,7 @@ describe('SearchService', () => {
})
httpTestingController = TestBed.inject(HttpTestingController)
+ settingsService = TestBed.inject(SettingsService)
service = TestBed.inject(SearchService)
})
@@ -36,4 +40,18 @@ describe('SearchService', () => {
)
expect(req.request.method).toEqual('GET')
})
+
+ it('should call correct api endpoint on globalSearch', () => {
+ const query = 'apple'
+ service.globalSearch(query).subscribe()
+ httpTestingController.expectOne(
+ `${environment.apiBaseUrl}search/?query=${query}`
+ )
+
+ settingsService.set(SETTINGS_KEYS.SEARCH_DB_ONLY, true)
+ subscription = service.globalSearch(query).subscribe()
+ httpTestingController.expectOne(
+ `${environment.apiBaseUrl}search/?query=${query}&db_only=true`
+ )
+ })
})
diff --git a/src-ui/src/app/services/rest/search.service.ts b/src-ui/src/app/services/rest/search.service.ts
index 4a75230d9..7a82d4f2f 100644
--- a/src-ui/src/app/services/rest/search.service.ts
+++ b/src-ui/src/app/services/rest/search.service.ts
@@ -1,15 +1,48 @@
import { HttpClient, HttpParams } from '@angular/common/http'
import { Injectable } from '@angular/core'
import { Observable } from 'rxjs'
-import { map } from 'rxjs/operators'
import { environment } from 'src/environments/environment'
-import { DocumentService } from './document.service'
+import { Document } from 'src/app/data/document'
+import { DocumentType } from 'src/app/data/document-type'
+import { Correspondent } from 'src/app/data/correspondent'
+import { CustomField } from 'src/app/data/custom-field'
+import { Group } from 'src/app/data/group'
+import { MailAccount } from 'src/app/data/mail-account'
+import { MailRule } from 'src/app/data/mail-rule'
+import { StoragePath } from 'src/app/data/storage-path'
+import { Tag } from 'src/app/data/tag'
+import { User } from 'src/app/data/user'
+import { Workflow } from 'src/app/data/workflow'
+import { SettingsService } from '../settings.service'
+import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
+import { SavedView } from 'src/app/data/saved-view'
+
+export interface GlobalSearchResult {
+ total: number
+ documents: Document[]
+ saved_views: SavedView[]
+ correspondents: Correspondent[]
+ document_types: DocumentType[]
+ storage_paths: StoragePath[]
+ tags: Tag[]
+ users: User[]
+ groups: Group[]
+ mail_accounts: MailAccount[]
+ mail_rules: MailRule[]
+ custom_fields: CustomField[]
+ workflows: Workflow[]
+}
@Injectable({
providedIn: 'root',
})
export class SearchService {
- constructor(private http: HttpClient) {}
+ public readonly searchResultObjectLimit: number = 3 // documents/views.py GlobalSearchView > OBJECT_LIMIT
+
+ constructor(
+ private http: HttpClient,
+ private settingsService: SettingsService
+ ) {}
autocomplete(term: string): Observable {
return this.http.get(
@@ -17,4 +50,19 @@ export class SearchService {
{ params: new HttpParams().set('term', term) }
)
}
+
+ globalSearch(query: string): Observable {
+ let params = new HttpParams().set('query', query)
+ if (this.searchDbOnly) {
+ params = params.set('db_only', true)
+ }
+ return this.http.get(
+ `${environment.apiBaseUrl}search/`,
+ { params }
+ )
+ }
+
+ public get searchDbOnly(): boolean {
+ return this.settingsService.get(SETTINGS_KEYS.SEARCH_DB_ONLY)
+ }
}
diff --git a/src-ui/src/styles.scss b/src-ui/src/styles.scss
index 22e4b348b..04b908720 100644
--- a/src-ui/src/styles.scss
+++ b/src-ui/src/styles.scss
@@ -87,7 +87,7 @@ table .btn-link {
color: var(--pngx-primary-text-contrast) !important;
}
-.navbar .dropdown .btn {
+.navbar .dropdown > .btn {
color: var(--pngx-primary-text-contrast) !important;
}
@@ -456,7 +456,7 @@ ul.pagination {
color: var(--bs-body-color);
&:hover, &:focus {
- background-color: var(--pngx-bg-alt);
+ background-color: var(--pngx-bg-darker);
color: var(--bs-body-color);
}
diff --git a/src-ui/src/theme.scss b/src-ui/src/theme.scss
index 806966ec7..98261b8da 100644
--- a/src-ui/src/theme.scss
+++ b/src-ui/src/theme.scss
@@ -142,7 +142,7 @@ $form-check-radio-checked-bg-image-dark: url("data:image/svg+xml,