Add EIF archive extraction with Face.dat ordering

Introduced EifExtractor to support extracting QQ EIF emoji archives, reordering images based on Face.dat metadata. Updated CompoundFileExtractor with in-memory extraction, enhanced the plugin menu and extraction workflow to prompt for Face.dat ordering, and added translations for the new prompt in Translations.config.
This commit is contained in:
ema
2025-12-26 23:46:29 +08:00
parent e7559f3900
commit b385fa7439
5 changed files with 246 additions and 15 deletions

View File

@@ -27,7 +27,7 @@ namespace QuickLook.Plugin.ArchiveViewer.CompoundFileBinary;
/// Utility class to extract streams and storages from a COM compound file (IStorage) into the file system.
/// This is a thin managed wrapper that enumerates entries inside the compound file and writes streams to disk.
/// </summary>
public static class CompoundFileExtractor
public static partial class CompoundFileExtractor
{
/// <summary>
/// Extracts all streams and storages from the compound file at <paramref name="compoundFilePath"/>
@@ -142,3 +142,77 @@ public static class CompoundFileExtractor
}
}
}
/// <summary>
/// Utility class to extract streams and storages from a COM compound file (IStorage) into the memory.
/// This is a thin managed wrapper that enumerates entries inside the compound file and writes streams to dictionary.
/// </summary>
public static partial class CompoundFileExtractor
{
/// <summary>
/// Extracts all streams from the compound file at <paramref name="compoundFilePath"/>
/// into a dictionary where the key is the relative path and the value is the file content.
/// </summary>
/// <param name="compoundFilePath">Path to the compound file (OLE compound file / structured storage).</param>
/// <returns>A dictionary containing the extracted files.</returns>
public static Dictionary<string, byte[]> ExtractToDictionary(string compoundFilePath)
{
var result = new Dictionary<string, byte[]>(StringComparer.OrdinalIgnoreCase);
// Ensure the compound file exists
if (!File.Exists(compoundFilePath))
throw new FileNotFoundException("Compound file not found.", compoundFilePath);
// Validate magic header for OLE compound file: D0 CF 11 E0 A1 B1 1A E1
byte[] magicHeader = [0xD0, 0xCF, 0x11, 0xE0, 0xA1, 0xB1, 0x1A, 0xE1];
byte[] header = new byte[8];
using (FileStream fs = new(compoundFilePath, FileMode.Open, FileAccess.Read, FileShare.Read))
{
int read = fs.Read(header, 0, header.Length);
if (read < header.Length || !header.SequenceEqual(magicHeader))
{
throw new InvalidDataException("The specified file does not appear to be an OLE Compound File (invalid header).");
}
}
// Open the compound file as an IStorage implementation wrapped by DisposableIStorage.
using DisposableIStorage storage = new(compoundFilePath, STGM.DIRECT | STGM.READ | STGM.SHARE_EXCLUSIVE, IntPtr.Zero);
ExtractStorageToDictionary(storage, string.Empty, result);
return result;
}
private static void ExtractStorageToDictionary(DisposableIStorage storage, string currentPath, Dictionary<string, byte[]> result)
{
IEnumerator<STATSTG> enumerator = storage.EnumElements();
// Enumerate all elements (streams and storages) at the root of the compound file.
while (enumerator.MoveNext())
{
STATSTG entryStat = enumerator.Current;
string entryPath = string.IsNullOrEmpty(currentPath) ? entryStat.pwcsName : Path.Combine(currentPath, entryStat.pwcsName);
// STGTY_STREAM indicates the element is a stream (treat as a file).
if (entryStat.type == (int)STGTY.STGTY_STREAM)
{
// Open the stream for reading from the compound file.
using DisposableIStream stream = storage.OpenStream(entryStat.pwcsName, IntPtr.Zero, STGM.READ | STGM.SHARE_EXCLUSIVE);
// Query stream statistics to determine its size.
STATSTG streamStat = stream.Stat((int)STATFLAG.STATFLAG_DEFAULT);
// Allocate a buffer exactly the size of the stream and read it in one call.
byte[] buffer = new byte[streamStat.cbSize];
stream.Read(buffer, buffer.Length);
result[entryPath] = buffer;
}
// STGTY_STORAGE indicates the element is a nested storage (treat as a directory).
else if (entryStat.type == (int)STGTY.STGTY_STORAGE)
{
using DisposableIStorage subStorage = storage.OpenStorage(entryStat.pwcsName, null, STGM.READ | STGM.SHARE_EXCLUSIVE, IntPtr.Zero);
ExtractStorageToDictionary(subStorage, entryPath, result);
}
}
}
}

View File

@@ -0,0 +1,95 @@
// Copyright © 2017-2025 QL-Win Contributors
//
// This file is part of QuickLook program.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
using System.Collections.Generic;
using System.IO;
using System.Linq;
namespace QuickLook.Plugin.ArchiveViewer.CompoundFileBinary;
/// <summary>
/// Utility to extract contents from an EIF archive and optionally reorder images
/// based on metadata stored in Face.dat. The EIF format is a Compound File Binary
/// (structured storage) used by QQ for emoji packs.
/// </summary>
public static class EifExtractor
{
/// <summary>
/// File name of the Face.dat metadata stream inside EIF archives.
/// Face.dat contains mapping information used to order and rename images.
/// </summary>
public const string FaceDat = "Face.dat";
/// <summary>
/// Extracts files from the compound file at <paramref name="path"/> into
/// <paramref name="outputDirectory"/>. If Face.dat exists inside the archive,
/// images will be renamed and reordered according to the mapping in Face.dat.
/// </summary>
/// <param name="path">Path to the EIF compound file.</param>
/// <param name="outputDirectory">Destination directory to write extracted files.</param>
public static void ExtractToDirectory(string path, string outputDirectory)
{
// Extract all streams from the compound file into an in-memory dictionary
Dictionary<string, byte[]> compoundFile = CompoundFileExtractor.ExtractToDictionary(path);
// If Face.dat exists, build mapping and reorder images accordingly
if (compoundFile.ContainsKey(FaceDat))
{
// Build group -> (filename -> index) mapping from Face.dat
Dictionary<string, Dictionary<string, int>> faceDat = FaceDatDecoder.Decode(compoundFile[FaceDat]);
// Flatten mapping to key '\\' joined: "group\filename" -> index
Dictionary<string, int> faceDatMapper = faceDat.SelectMany(
outer => outer.Value,
(outer, inner) => new { Key = $@"{outer.Key}\{inner.Key}", inner.Value })
.ToDictionary(x => x.Key, x => x.Value);
// Prepare output dictionary for files that match mapping
Dictionary<string, byte[]> output = [];
foreach (var kv in faceDatMapper)
{
if (compoundFile.ContainsKey(kv.Key))
{
// Create a new key using the index as file name and keep original extension
string newKey = Path.Combine(Path.GetDirectoryName(kv.Key),
faceDatMapper[kv.Key] + Path.GetExtension(kv.Key));
output[newKey] = compoundFile[kv.Key];
}
}
// Ensure target directory exists
Directory.CreateDirectory(outputDirectory);
// Write each matched file to disk using its new name
foreach (var kv in output)
{
(string relativePath, byte[] data) = (kv.Key, kv.Value);
string fullPath = Path.Combine(outputDirectory, relativePath);
// Ensure parent directory exists
string dir = Path.GetDirectoryName(fullPath);
if (!string.IsNullOrEmpty(dir))
Directory.CreateDirectory(dir);
// Write file bytes
File.WriteAllBytes(fullPath, data);
}
}
}
}

View File

@@ -29,6 +29,7 @@ namespace QuickLook.Plugin.ArchiveViewer.CompoundFileBinary;
/// - Locates a repeating-key pattern and extracts the XOR-encrypted block
/// - XOR-decodes the block and parses group\filename entries
/// Provides a method to build the same group -> (filename -> index) mapping as the Python tool.
/// Reference: https://github.com/readme9txt/QQEIF-Extractor
/// </summary>
public static class FaceDatDecoder
{

View File

@@ -25,6 +25,7 @@ using System.Collections.Generic;
using System.IO;
using System.Reflection;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Input;
using WindowsAPICodePack.Dialogs;
@@ -32,17 +33,30 @@ namespace QuickLook.Plugin.ArchiveViewer;
public partial class Plugin
{
/// <summary>
/// Command to extract archive contents to a directory. Executed asynchronously.
/// </summary>
public ICommand ExtractToDirectoryCommand { get; }
/// <summary>
/// Constructor - initializes commands used by the plugin.
/// </summary>
public Plugin()
{
ExtractToDirectoryCommand = new AsyncRelayCommand(ExtractToDirectoryAsync);
}
/// <summary>
/// Return additional "More" menu items for the plugin.
/// When the current file is an EIF archive, a menu item to extract to directory is provided.
/// </summary>
public IEnumerable<IMenuItem> GetMenuItems()
{
if (_path.EndsWith(".eif", StringComparison.OrdinalIgnoreCase))
// Currently only supports for CFB and EIF files
if (_path.EndsWith(".cfb", StringComparison.OrdinalIgnoreCase)
|| _path.EndsWith(".eif", StringComparison.OrdinalIgnoreCase))
{
// Use external Translations.config shipped next to the executing assembly
string translationFile = Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), "Translations.config");
yield return new MoreMenuItem()
@@ -55,6 +69,10 @@ public partial class Plugin
}
}
/// <summary>
/// Show folder picker and extract archive contents to the chosen directory.
/// For EIF files, prompt the user whether to apply EIF-specific Face.dat ordering.
/// </summary>
public async Task ExtractToDirectoryAsync()
{
using CommonOpenFileDialog dialog = new()
@@ -64,25 +82,39 @@ public partial class Plugin
if (dialog.ShowDialog() == CommonFileDialogResult.Ok)
{
await Task.Run(() =>
if (_path.EndsWith(".cfb", StringComparison.OrdinalIgnoreCase))
{
if (_path.EndsWith(".cfb", StringComparison.OrdinalIgnoreCase))
// Generic compound file extraction
await Task.Run(() =>
{
CompoundFileExtractor.ExtractToDirectory(_path, dialog.FileName);
}
else if (_path.EndsWith(".eif", StringComparison.OrdinalIgnoreCase))
});
}
else if (_path.EndsWith(".eif", StringComparison.OrdinalIgnoreCase))
{
string translationFile = Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), "Translations.config");
// Ask the user whether to apply EIF-specific `Face.dat` ordering during extraction
MessageBoxResult result = MessageBox.Show(TranslationHelper.Get("MW_ExtractToDirectory_EIFOrderFaceDat",
translationFile), "QuickLook", MessageBoxButton.YesNo, MessageBoxImage.Question);
// If user chooses Yes, use EifExtractor which reorders images according to `Face.dat`
if (result == MessageBoxResult.Yes)
{
CompoundFileExtractor.ExtractToDirectory(_path, dialog.FileName);
string faceDatPath = Path.Combine(dialog.FileName, "face.dat");
if (File.Exists(faceDatPath))
await Task.Run(() =>
{
Dictionary<string, Dictionary<string, int>> faceDat = FaceDatDecoder.Decode(File.ReadAllBytes(faceDatPath));
_ = faceDat;
}
EifExtractor.ExtractToDirectory(_path, dialog.FileName);
});
}
});
else
{
// Fallback: generic compound file extraction
await Task.Run(() =>
{
CompoundFileExtractor.ExtractToDirectory(_path, dialog.FileName);
});
}
}
}
}
}

View File

@@ -3,89 +3,118 @@
<Translations>
<ar>
<MW_ExtractToDirectory>استخراج إلى المجلد</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>هل تريد الاحتفاظ بترتيب ملفات الرموز التعبيرية المخزنة؟</MW_ExtractToDirectory_EIFOrderFaceDat>
</ar>
<ca>
<MW_ExtractToDirectory>Extreu a la carpeta</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Voleu mantenir l'ordre dels fitxers d'emoticones emmagatzemats?</MW_ExtractToDirectory_EIFOrderFaceDat>
</ca>
<he>
<MW_ExtractToDirectory>חלץ לתיקייה</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>האם ברצונך לשמור על סדר קבצי הרגשונים המאוחסנים?</MW_ExtractToDirectory_EIFOrderFaceDat>
</he>
<hi>
<MW_ExtractToDirectory>डायरेक्टरी में निकालें</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>क्या आप संग्रहीत इमोटिकॉन फ़ाइलों का क्रम बनाए रखना चाहते हैं?</MW_ExtractToDirectory_EIFOrderFaceDat>
</hi>
<mr>
<MW_ExtractToDirectory>डायरेक्टरीमध्ये काढा</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>आपण संग्रहित इमोटिकॉन फायलींचा क्रम ठेवू इच्छिता?</MW_ExtractToDirectory_EIFOrderFaceDat>
</mr>
<hu-HU>
<MW_ExtractToDirectory>Kibontás mappába</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Meg akarja tartani a tárolt hangulatjel-fájlok sorrendjét?</MW_ExtractToDirectory_EIFOrderFaceDat>
</hu-HU>
<nb-NO>
<MW_ExtractToDirectory>Pakk ut til mappe</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Vil du beholde rekkefølgen på lagrede uttrykksikonfiler?</MW_ExtractToDirectory_EIFOrderFaceDat>
</nb-NO>
<nl-NL>
<MW_ExtractToDirectory>Uitpakken naar map</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Wilt u de volgorde van opgeslagen emoticonbestanden behouden?</MW_ExtractToDirectory_EIFOrderFaceDat>
</nl-NL>
<sk>
<MW_ExtractToDirectory>Extrahovať do priečinka</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Chcete zachovať poradie uložených súborov emotikonov?</MW_ExtractToDirectory_EIFOrderFaceDat>
</sk>
<id-ID>
<MW_ExtractToDirectory>Ekstrak ke folder</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Apakah Anda ingin menjaga urutan file emotikon yang tersimpan?</MW_ExtractToDirectory_EIFOrderFaceDat>
</id-ID>
<en>
<MW_ExtractToDirectory>Extract to directory</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Do you want to keep the order of stored emoticon files?</MW_ExtractToDirectory_EIFOrderFaceDat>
</en>
<ko>
<MW_ExtractToDirectory>폴더로 추출</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>이모티콘 파일의 저장 순서를 유지하시겠습니까?</MW_ExtractToDirectory_EIFOrderFaceDat>
</ko>
<pt-BR>
<MW_ExtractToDirectory>Extrair para a pasta</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Deseja manter a ordem dos arquivos de emoticons armazenados?</MW_ExtractToDirectory_EIFOrderFaceDat>
</pt-BR>
<pt-PT>
<MW_ExtractToDirectory>Extrair para a pasta</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Deseja manter a ordem dos ficheiros de emoticons armazenados?</MW_ExtractToDirectory_EIFOrderFaceDat>
</pt-PT>
<ru-RU>
<MW_ExtractToDirectory>Извлечь в папку</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Вы хотите сохранить порядок сохраненных файлов смайликов?</MW_ExtractToDirectory_EIFOrderFaceDat>
</ru-RU>
<tr-TR>
<MW_ExtractToDirectory>Klasöre çıkar</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Saklanan ifade dosyalarının sırasını korumak istiyor musunuz?</MW_ExtractToDirectory_EIFOrderFaceDat>
</tr-TR>
<vi>
<MW_ExtractToDirectory>Trích xuất vào thư mục</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Bạn có muốn giữ thứ tự của các tệp biểu tượng cảm xúc đã lưu không?</MW_ExtractToDirectory_EIFOrderFaceDat>
</vi>
<pt-PT>
<MW_ExtractToDirectory>Extrair para a pasta</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Deseja manter a ordem dos ficheiros de emoticons armazenados?</MW_ExtractToDirectory_EIFOrderFaceDat>
</pt-PT>
<fr>
<MW_ExtractToDirectory>Extraire vers le dossier</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Voulez-vous conserver l'ordre des fichiers d'émoticônes stockés ?</MW_ExtractToDirectory_EIFOrderFaceDat>
</fr>
<es>
<MW_ExtractToDirectory>Extraer a la carpeta</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>¿Desea mantener el orden de los archivos de emoticonos almacenados?</MW_ExtractToDirectory_EIFOrderFaceDat>
</es>
<it>
<MW_ExtractToDirectory>Estrai nella cartella</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Vuoi mantenere l'ordine dei file di emoticon memorizzati?</MW_ExtractToDirectory_EIFOrderFaceDat>
</it>
<pl>
<MW_ExtractToDirectory>Wyodrębnij do folderu</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Czy chcesz zachować kolejność przechowywanych plików emotikonów?</MW_ExtractToDirectory_EIFOrderFaceDat>
</pl>
<el>
<MW_ExtractToDirectory>Εξαγωγή σε φάκελο</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Θέλετε να διατηρήσετε τη σειρά των αποθηκευμένων αρχείων emoticon;</MW_ExtractToDirectory_EIFOrderFaceDat>
</el>
<uk-UA>
<MW_ExtractToDirectory>Розпакувати до папки</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Ви хочете зберегти порядок збережених файлів смайлів?</MW_ExtractToDirectory_EIFOrderFaceDat>
</uk-UA>
<zh-CN>
<MW_ExtractToDirectory>提取到目录</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>是否需要保持表情文件存储的顺序?</MW_ExtractToDirectory_EIFOrderFaceDat>
</zh-CN>
<zh-TW>
<MW_ExtractToDirectory>提取到資料夾</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>是否需要保持表情檔案儲存的順序?</MW_ExtractToDirectory_EIFOrderFaceDat>
</zh-TW>
<ja>
<MW_ExtractToDirectory>フォルダに抽出</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>絵文字ファイルの保存順序を保持しますか?</MW_ExtractToDirectory_EIFOrderFaceDat>
</ja>
<de>
<MW_ExtractToDirectory>In Ordner extrahieren</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Möchten Sie die Reihenfolge der gespeicherten Emoticon-Dateien beibehalten?</MW_ExtractToDirectory_EIFOrderFaceDat>
</de>
<sv>
<MW_ExtractToDirectory>Extrahera till mapp</MW_ExtractToDirectory>
<MW_ExtractToDirectory_EIFOrderFaceDat>Vill du behålla ordningen på lagrade uttryckssymbolfiler?</MW_ExtractToDirectory_EIFOrderFaceDat>
</sv>
</Translations>