Merge pull request meld-cp#85 from meld-cp:meld-cp/issue63

Auto decrypt note if password known

Author: meld-cp

.vscode/settings.json

@@ -1,5 +1,7 @@
 {
 	"cSpell.words": [
-		"decryptable"
+		"decryptable",
+		"encryptable",
+		"Inplace"
 	]
 }

src/features/feature-inplace-encrypt/FeatureInplaceEncrypt.ts

@@ -241,7 +241,7 @@ export default class FeatureInplaceEncrypt implements IMeldEncryptPluginFeature{
 		let defaultPassword = '';
 		let defaultHint = selectionAnalysis.decryptable?.hint;
 		if ( this.pluginSettings.rememberPassword ){
-			const bestGuessPasswordAndHint = SessionPasswordService.getBestGuess( activeFile );
+			const bestGuessPasswordAndHint = SessionPasswordService.get( activeFile );
 			//console.debug({bestGuessPasswordAndHint});
 
 			defaultPassword = bestGuessPasswordAndHint.password;

src/features/feature-whole-note-encrypt/EncryptedFileContentView.ts

@@ -31,8 +31,9 @@ export class EncryptedFileContentView extends TextFileView {
 		//console.debug('EncryptedFileContentView.constructor', {leaf});
 
 		this.elActionIconLockNote = this.addAction( 'lock', 'Lock', () => this.actionLockFile() );
-
 		this.elActionChangePassword = this.addAction( 'key', 'Change Password', () => this.actionChangePassword() );
+		this.elActionIconLockNote.hide();
+		this.elActionChangePassword.hide();
 
 		this.contentEl.style.display = 'flex';
 		this.contentEl.style.flexDirection = 'column';
@@ -42,6 +43,7 @@ export class EncryptedFileContentView extends TextFileView {
 
 	private actionLockFile(){
 		this.encryptionPassword = '';
+		SessionPasswordService.clearForFile( this.file );
 		this.refreshView(EncryptedFileContentViewStateEnum.decryptNote);
 	}
 
@@ -72,7 +74,7 @@ export class EncryptedFileContentView extends TextFileView {
 		super.onPaneMenu(menu,source);
 	}
 
-	private createTitle( title:string ) : HTMLElement{
+	private addTitle( title:string ) : HTMLElement{
 		return this.contentEl.createDiv({
 			text : `🔐 ${title} 🔐`,
 			attr : {
@@ -93,9 +95,12 @@ export class EncryptedFileContentView extends TextFileView {
 		return passwordMatch ? '' :'Password doesn\'t match';
 	}
 
-	private createNewNoteView() : HTMLElement {
+	private addNewNoteView() {
+		
+		this.addTitle('This note will be encrypted');
+
 		//console.debug('createDecryptNoteView', { "hint": this.hint} );
-		const container = this.createInputContainer();
+		const container = this.addInputContainer();
 
 		new Setting(container)
 			.setDesc('Please provide a password and hint to start editing this note.')
@@ -123,7 +128,7 @@ export class EncryptedFileContentView extends TextFileView {
 			}
 		}
 
-		const bestGuessPassAndHint = SessionPasswordService.getBestGuess( this.file );
+		const bestGuessPassAndHint = SessionPasswordService.get( this.file );
 		let password = bestGuessPassAndHint.password;
 		let confirm = '';
 		let hint = bestGuessPassAndHint.hint;
@@ -191,24 +196,21 @@ export class EncryptedFileContentView extends TextFileView {
 			})
 		;
 
-		return container;
 	}
 
+	private addDecryptNoteView() {
+		
+		this.addTitle('This note is encrypted');
 
-	private createDecryptNoteView() : HTMLElement {
-		const container = this.createInputContainer();
-
+		const container = this.addInputContainer();
+		
 		new Setting(container)
 			.setDesc('Please provide a password to unlock this note.')
 		;
 
-		const bestGuessPassAndHint = SessionPasswordService.getBestGuess( this.file );
-		this.encryptionPassword = bestGuessPassAndHint.password;
-
 		UiHelper.buildPasswordSetting({
 			container,
 			name:'Password:',
-			initialValue: this.encryptionPassword,
 			autoFocus : true,
 			placeholder: this.formatHint(this.hint),
 			onChangeCallback: (value) => {
@@ -228,7 +230,21 @@ export class EncryptedFileContentView extends TextFileView {
 			})
 		;
 
-		return container;
+		// try to decode and go to edit mode if password is known
+		const bestGuessPassAndHint = SessionPasswordService.get( this.file );
+		this.encryptionPassword = bestGuessPassAndHint.password;
+		
+		this.decryptWithPassword( bestGuessPassAndHint.password )
+			.then( decryptedText => {
+				if ( decryptedText != null ){
+					this.currentEditorText = decryptedText;
+					this.refreshView( EncryptedFileContentViewStateEnum.editNote );
+					new Notice('Decrypted using remembered password', 2000);
+				}
+			})
+		;
+
+
 	}
 
 	private async encodeAndSave( ){
@@ -251,36 +267,40 @@ export class EncryptedFileContentView extends TextFileView {
 		}
 	}
 
-	private createEditorView() : HTMLElement {
-		//const container = this.contentEl.createEl('textarea');
+	private addEditorView() {
+
+		this.elActionIconLockNote.show();
+		this.elActionChangePassword.show();
+
+		this.addTitle('This note is encrypted');
+
 		const container = this.contentEl.createDiv();
 		container.contentEditable = 'true';
 		container.style.flexGrow = '1';
 		container.style.alignSelf = 'stretch';
 
-		//container.value = this.currentEditorText
 		container.innerText = this.currentEditorText;
 		container.focus();
 
 		container.on('input', '*', async (ev, target) =>{
-			//console.debug('editor input',{ev, target});
-			//this.currentEditorText = container.value;
 			this.currentEditorText = container.innerText;
 			await this.encodeAndSave();
 		});
-		return container;
 	}
 
-	private createInputContainer() : HTMLElement{
+	private addInputContainer() : HTMLElement{
 		return this.contentEl.createDiv( {
 			'attr': {
 				'style': 'width:100%; max-width:400px;'
 			}
 		} );
 	}
 
-	private createChangePasswordView() : HTMLElement {
-		const container = this.createInputContainer();
+	private addChangePasswordView() {
+
+		this.addTitle('Change encrypted note password');
+
+		const container = this.addInputContainer();
 
 		let newPassword = '';
 		let confirm = '';
@@ -300,6 +320,9 @@ export class EncryptedFileContentView extends TextFileView {
 
 				this.encodeAndSave();
 				this.refreshView( EncryptedFileContentViewStateEnum.editNote );
+
+				SessionPasswordService.put( {password: newPassword, hint: newHint}, this.file );
+
 				new Notice('Password and Hint were changed');
 			}
 		}
@@ -378,8 +401,6 @@ export class EncryptedFileContentView extends TextFileView {
 				;
 			})
 		;
-
-		return container;
 	}
 
 	private formatHint( hint:string ): string{
@@ -406,39 +427,35 @@ export class EncryptedFileContentView extends TextFileView {
 
 		switch (this.currentView) {
 			case EncryptedFileContentViewStateEnum.newNote:
-				this.createTitle('This note will be encrypted');
-				this.createNewNoteView();
+				this.addNewNoteView();
 			break;
 
 			case EncryptedFileContentViewStateEnum.decryptNote:
-				this.createTitle('This note is encrypted');
-				this.createDecryptNoteView();
+				this.addDecryptNoteView();
 			break;
 
 			case EncryptedFileContentViewStateEnum.editNote:
-				this.elActionIconLockNote.show();
-				this.elActionChangePassword.show();
-				this.createTitle('This note is encrypted');
-				this.createEditorView();
+				this.addEditorView();
 			break;
 
 			case EncryptedFileContentViewStateEnum.changePassword:
-				this.createTitle('Change encrypted note password');
-				this.createChangePasswordView();
+				this.addChangePasswordView();
 			break;
 		}
 
 	}
 
+	async decryptWithPassword( pw: string ) : Promise<string | null>{
+		if ( pw.length == 0 ){
+			return null;
+		}
+		const fileData = JsonFileEncoding.decode( this.data );
+		const decryptedText = await FileDataHelper.decrypt( fileData, pw );
+		return decryptedText;
+	}
+
 	async handleDecryptButtonClick() {
-		const fileData = JsonFileEncoding.decode(this.data)
-						
-		//console.debug('Decrypt button', fileData);
-
-		const decryptedText = await FileDataHelper.decrypt(
-			fileData,
-			this.encryptionPassword
-		);
+		const decryptedText = await this.decryptWithPassword( this.encryptionPassword );
 
 		if (decryptedText === null){
 			new Notice('Decryption failed');

src/main.ts

@@ -46,10 +46,12 @@ export default class MeldEncrypt extends Plugin {
 	}
 
 	async loadSettings() {
+		
 		const DEFAULT_SETTINGS: IMeldEncryptPluginSettings = {
 			confirmPassword: true,
 			rememberPassword: true,
 			rememberPasswordTimeout: 30,
+			rememberPasswordLevel: SessionPasswordService.LevelFullPath,
 
 			featureWholeNoteEncrypt: {
 				addRibbonIconToCreateNote: true,
@@ -72,6 +74,7 @@ export default class MeldEncrypt extends Plugin {
 			? null
 			: this.settings.rememberPasswordTimeout
 		);
+		SessionPasswordService.setLevel( this.settings.rememberPasswordLevel );
 	}
 
 	async saveSettings() {

src/services/MemoryCache.ts

@@ -35,6 +35,10 @@ export class MemoryCache<T> {
 		return Array.from( this.values.keys() );
 	}
 
+	public removeKey( key: string ) : boolean{
+		return this.values.delete( key );
+	}
+
 	public clear() {
 		this.values.clear();
 	}

src/services/SessionPasswordService.ts

@@ -10,13 +10,17 @@ export class SessionPasswordService{
 
 	private static isActive = true;
 
-	private static blankPasswordAndHint : IPasswordAndHint = {password:'', hint:'' };
+	private static blankPasswordAndHint : IPasswordAndHint = { password:'', hint:'' };
 
 	private static cache = new MemoryCache<IPasswordAndHint>();
 
 	private static baseMinutesToExpire = 0;
 	private static expiryTime : number | null = null;
 
+	public static LevelFullPath = 'fullPath';
+	public static LevelParentPath = 'parentPath';
+	private static level = SessionPasswordService.LevelFullPath;
+
 	public static setActive( isActive: boolean) {
 		SessionPasswordService.isActive = isActive;
 		if (!SessionPasswordService.isActive){
@@ -33,6 +37,14 @@ export class SessionPasswordService{
 		SessionPasswordService.updateExpiryTime();
 	}
 
+	public static setLevel( level: string ) {
+		if ( SessionPasswordService.level == level ){
+			return;
+		}
+		SessionPasswordService.level = level;
+		this.clear();
+	}
+
 	public static updateExpiryTime() : void {
 		if (
 			SessionPasswordService.baseMinutesToExpire == 0
@@ -49,40 +61,33 @@ export class SessionPasswordService{
 			return;
 		}
 
-		this.cache.put(file.path, pw);
-		this.cache.put(file.parent.path, pw)
-		this.cache.put(file.basename, pw);
+		const key = SessionPasswordService.getFileCacheKey( file );
+
+		this.cache.put( key, pw );
 
 		SessionPasswordService.updateExpiryTime();
 	}
 
-	public static getExact( file : TFile ): IPasswordAndHint {
+	public static get( file : TFile ): IPasswordAndHint {
 		if (!SessionPasswordService.isActive){
 			return SessionPasswordService.blankPasswordAndHint;
 		}
+		
 		this.clearIfExpired();
 		SessionPasswordService.updateExpiryTime();
-		return this.cache.get(file.path, SessionPasswordService.blankPasswordAndHint);
-	}
 
-	public static getBestGuess( file : TFile ): IPasswordAndHint {
-		if (!SessionPasswordService.isActive){
-			return SessionPasswordService.blankPasswordAndHint;
-		}
+		const key = SessionPasswordService.getFileCacheKey( file );
+		return this.cache.get( key, SessionPasswordService.blankPasswordAndHint );
+	}
 
-		this.clearIfExpired();
-		SessionPasswordService.updateExpiryTime();
+	private static getFileCacheKey( file : TFile ) : string {
+		switch (SessionPasswordService.level) {
+			case SessionPasswordService.LevelParentPath:
+				return file.parent.path;
 
-		const buestGuess = this.cache.getFirst(
-			[
-				file.path,
-				file.parent.path,
-				file.basename
-			],
-			SessionPasswordService.blankPasswordAndHint
-		);
-
-		return buestGuess;
+			default:
+				return file.path;
+		}
 	}
 
 	private static clearIfExpired() : void{
@@ -95,6 +100,10 @@ export class SessionPasswordService{
 		this.clear();
 	}
 
+	public static clearForFile( file: TFile ) : void {
+		const key = SessionPasswordService.getFileCacheKey( file );
+		this.cache.removeKey( key );
+	}
 
 	public static clear(): void{
 		this.cache.clear();

src/settings/MeldEncryptPluginSettings.ts

@@ -5,6 +5,7 @@ export interface IMeldEncryptPluginSettings {
 	confirmPassword: boolean;
 	rememberPassword: boolean;
 	rememberPasswordTimeout: number;
+	rememberPasswordLevel: string;
 
 	featureWholeNoteEncrypt : IFeatureWholeNoteEncryptSettings;
 	featureInplaceEncrypt : IFeatureInplaceEncryptSettings;