Filter out exclude files when processing a backup file

Automattic · Jul 16, 2024 · caa31a0 · caa31a0
1 parent 2c06a8c
commit caa31a0
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 4 deletions.
diff --git a/src/lib/import-export/import/handlers/backup-handler-factory.ts b/src/lib/import-export/import/handlers/backup-handler-factory.ts
@@ -8,6 +8,16 @@ export interface BackupHandler {
 	extractFiles( file: BackupArchiveInfo, extractionDirectory: string ): Promise< void >;
 }
 
+const EXCLUDED_FILES_PATTERNS = [
+	/^__MACOSX\/.*/, // MacOS meta folder
+	/^\..*/, // Unix hidden files at root
+	/\/\..*/, // Unix hidden files at subfolders
+];
+
+export function isFileAllowed( filePath: string ) {
+	return EXCLUDED_FILES_PATTERNS.every( ( pattern ) => ! pattern.test( filePath ) );
+}
+
 export class BackupHandlerFactory {
 	private static zipTypes = [
 		'application/zip',

diff --git a/src/lib/import-export/import/handlers/backup-handler-tar-gz.ts b/src/lib/import-export/import/handlers/backup-handler-tar-gz.ts
@@ -2,14 +2,14 @@ import fs from 'fs';
 import zlib from 'zlib';
 import * as tar from 'tar';
 import { BackupArchiveInfo } from '../types';
-import { BackupHandler } from './backup-handler-factory';
+import { BackupHandler, isFileAllowed } from './backup-handler-factory';
 
 export class BackupHandlerTarGz implements BackupHandler {
 	async listFiles( backup: BackupArchiveInfo ): Promise< string[] > {
 		const files: string[] = [];
 		await tar.t( {
 			file: backup.path,
-			onReadEntry: ( entry ) => files.push( entry.path ),
+			onReadEntry: ( entry ) => isFileAllowed( entry.path ) && files.push( entry.path ),
 		} );
 		return files;
 	}

diff --git a/src/lib/import-export/import/handlers/backup-handler-zip.ts b/src/lib/import-export/import/handlers/backup-handler-zip.ts
@@ -1,11 +1,14 @@
 import AdmZip from 'adm-zip';
 import { BackupArchiveInfo } from '../types';
-import { BackupHandler } from './backup-handler-factory';
+import { BackupHandler, isFileAllowed } from './backup-handler-factory';
 
 export class BackupHandlerZip implements BackupHandler {
 	async listFiles( backup: BackupArchiveInfo ): Promise< string[] > {
 		const zip = new AdmZip( backup.path );
-		return zip.getEntries().map( ( entry ) => entry.entryName );
+		return zip
+			.getEntries()
+			.map( ( entry ) => entry.entryName )
+			.filter( isFileAllowed );
 	}
 
 	async extractFiles( file: BackupArchiveInfo, extractionDirectory: string ): Promise< void > {