What's in a IFilter?

The IFilter interface was designed by Microsoft for use in its Indexing Service. Its main purpose is to extract text from files so the Indexing Service can index them and later search them. Some versions of Windows comes with IFilter implementations for Office files, and there are free and commercial filters available for other file types (Adobe PDF filter is a popular one). The IFilter interface is used mainly in non-text files like Office documents, PDF documents etc., but is also used for text files like HTML and XML, to extract only the important parts of the file. Although the IFilter interface can be used for general purpose text extraction from documents, it is generally used in search engines. Windows Desktop Search uses filters to index files. For more information on IFilter, see the Links section.

So what else is new?

There are already quite a few articles and pieces of information on how to use the IFilter interface in .NET (see the Links section), so why write another article you ask? Well, there are some problems with the implementations offered in those articles (details below) which caused me to take a different approach to using and loading filters. I'm currently using this implementation in a new product I'm developing (more details will be revealed here), and since it's working great, I decided to share it with you (yes, You!).

Issues with the current implementations

These are the issues I and others have found with the current implementations, I'll discuss each in detail below:

Extracting text from very large files.

COM threading issues.

Adobe PDF filter crashing the application when it's closed.

Extracting text from very large files

All of the sample code I found on using IFilters in C# provided a method that extracts the entire text of a document and returns that as a string. Usually, it's something like this:

publicstaticstring GetTextFromFile(string path)

Now, this might be OK for some uses, but for a general purpose indexer, I find that it isn't the most scalable way to extract text from documents. Some documents may be very large (30 MB PDFs or Word documents are not uncommon), and extracting the entire text at once can have negative effects on the garbage collector since these objects will be stored in the .NET "Large Objects Heap" (see the Links section for more information).

COM threading issues

Since filters are essentially COM objects, they carry with them all the COM threading model issues that we all love to hate. See the Links section for some of the reported problems. To make a long story short, some filters are marked as STA (Adobe PDF filter), some as MTA (Microsoft XML filter), and some as Both (Microsoft Office Filter). This means MTA filters will not load into C# threads that are marked with the [STAThread], and STA filters will not load into [MTAThread] threads. Some people recommend manually changing the registry to mark "problematic" filters as Both, but this isn't something you want to do during the installation of a product, nor can you reliably do it because you don't know which filters are installed on the customer's machine. We basically need a way to load an IFilter and use it no matter what its threading model or our threading model is.

Adobe PDF filter crashing the application when it's closed

There are quite a few reports about problems with the Adobe PDF filter v6. See this and this for some examples. I researched this issue for some time, and I believe I found what the problem is. It seems Adobe forgot (or not..) to export the DllCanUnloadNow function from their PDFFILT.dll. Since a filter is implemented as a COM object, it should export this function to let COM know when it can unload this library. It seems that this causes problems for C# applications because the .dll is never unloaded, and when it does, it's probably a bit late.

In a previous version of my application, I managed to work around this issue by specifically unloading the PDFFILT.dll library. In the current implementation, this workaround is not needed.

How my implementation solves these issues?

Implement a FilterReader

I decided to go the hard way and implement a TextReader derived class called FilterReader. This solves issue #1 because we don't have to extract the entire text at once. Instead, you can simply use the reader to get a buffer at a time. If you still want to get the entire text as a string, use the ReadToEnd() method.

Bypassing COM

In order to get an IFilter instance, you should call the LoadIFilter API and pass it a file name. LoadIFilter eventually calls CoCreateInstance() to actually instantiate the filter, and thus abide to COM rules. To avoid the threading issues, I decided to bypass COM and instantiate the filter COM class myself. This has the following implications and assumptions:

I needed to find the correct COM class that implements the filter for a specific file type.

I needed to dynamically load the COM DLL that implements that COM class and call the DllGetClassObject function that is exported from that .dll.

I didn't want to re-implement all of the COM infrastructure, so in order to solve the issue of unloading COM DLLs only when they're not needed, I decided to keep the DLLs loaded during the entire application lifetime and only unload them when the application dies. Note that this essentially solves issue #3 since we manually unload the PDFFILT.dll.

An IFilter should not be used by multiple threads since it is no longer protected by COM.

I assumed that STA filters will behave correctly when called from an MTA thread when COM is not involved. Until now, I didn't encounter any problem with this approach. If you find a filter that behaves badly when used this way, please let me know.

The details

Finding the correct COM class

Since I've decided not to use LoadIFilter, I needed to find a way to locate the correct DLL and class ID of the object implementing the filter for the file whose text we're interested in. This was a simple task, thanks to the excellent RegMon utility from SysInternals. I simply called LoadIFilter and traced which registry keys where read during that operation. I then used the same logic in my own implementation. The details can be found in the FilterLoader class. When a class\DLL pair is found for a certain file extension, this information is cached to avoid traversing the registry again.

During the research I made on how LoadIFilter works, I came across a utility called IFilter Explorer that shows which filters are installed on your computer. From that tool, I also learned that some indexing engines use methods not implemented in LoadIFilter to find filters. One of these methods uses the content type registered for that extension. My version of LoadIFilter also handles loading filters for files that have no filter registered for them but do have a filter registered for their content type.

Loading the DLL and instantiating the filter implementation

OK, so we have the name of the DLL and the ID of the class implementing our filter, how do we create an instance of that class? Most of the work is handled by the ComHelper class. The steps needed to accomplish that are:

Load the DLL using the LoadLibrary Win32 API.

Call the GetProcAddress Win32 API to get a pointer to the DllGetClassObject function.

Use Marshal.GetDelegateForFunctionPointer() to convert that function pointer to a delegate. Note: this is only available in .NET 2.0. For an equivalent method in .NET 1.1, see the Links section.

Hi,
The pdf document(with OCR) and MS-office file can get the text on windows 2003 x86 which 32 bit operation system,without install any ifilter plugin. but when I upgrade to windows 2008 x64, pdf document and MS-office file can not get the text, program no any error popup, the return result is empty string,so install the "FilterPack64bit.exe"(from Microsoft) then MS-office can get text. but install the "PDF iFilter 64 11.0.01"(from Adobe) ,pdf document still can not get the text. later, I install "Foxit PDF iFilter 3.0" then can get the PDF text. now I had used the "iTextSharp" to get PDF text however speed so lower.

about how to get the pdf text, I had tried "PdfBox",but it get the chinese char not good.

I am trying to use it with in my website that is built on framework 4.0 but it always returns an exception no filter defined. To check this i created a basic forms application and used and same error was received unless the project was first downgraded to 2.0 and then again upgraded. After it, it works correctly. The issue is that i cant down grade my website as it is using other APIs that wont work with a lesser version. Kindly help!

Hi Aminooe,
I am new to use COM+ object
Thanks you very much, your code works to me
I would like to ask if it is necessary to close the filestream after the
"Stream fileStream = new System.IO.FileStream(fileName, FileMode.Open);"?
And where should I close the steam if it is needed?
Thanks.

Hi author，
My English is not good, I hope you can understand me and give me some help.
When I use this code, I catch a System.ArgumentException. I build a new word and do nothing to it. I use this code to read it and then I catch the System.ArgumentException.The program will stop at the last sentence. If I add any words into the word and there will be no erro. I use the office2010.
Looking forward for your help.

I am using IFilter in a Windows Server 2008 64 bits with adobe ifilter 9 64 bits.
I can extract the text with no problem in a batch script but if i try to use the component in an asp i get the following error "Interface not registered (Exception from HRESULT: 0x80040155)". This only happens in the second time i execute the ifilter.

Hi Eyal, thanks for sharing your code and experiences - I've found your wrapper excellent and the best around by far.

You mentioned in an earlier post that you wouldn't mind if the code is used in open source applications. That's the case with us - we'd like to use it via GPL but it says Ms-PL in the bottom of the description. So would it be alright to use it via GPL, we would also attribute your effort in the about section of our app and on the wiki docu page as well.

I found a problem with the code I put in.
Right now the existing code will wait for IFilter.GetChunk() returns FILTER_E_END_OF_CHUNKS twice before exiting (i.e. exit condition = endOfChunksCount>1 where endOfChunksCount initialized as 0). And for some reason this part of the code is working fine for most of the format except for MS Office 2010 format (i.e. docx, xlsx...etc) Those file will throw 0x8000FFFF right after the first FILTER_E_END_OF_CHUNKS and then GetChunk() will go back to normal. Therefore, if the above code is implemented, then before normal exit, 0x8000FFFF will be thrown.

Now if I change the code to exit when first FILTER_E_END_OF_CHUNKS is received, everything seems to work properly. So I was wondering, is there any reason why we need 2x FILTER_E_END_OF_CHUNKS before setting _done = true?

I installed the latest FoxIT IFilters on a Windows 7 workstation. The actual DLLs are detected via their handler and persist class GUIDs. However, when trying to load the filter from the DLL, the code fails on: