Test des gestionnaires de filtres
La suite de tests IFilter valide vos gestionnaires de filtre. La suite de tests le fait en appelant les méthodes IFilter et en vérifiant la conformité des valeurs retournées à la spécification de l’interface IFilter ; et vérifier que les identificateurs de segment sont uniques et croissants, que l’interface IFilter se comporte de manière cohérente après la réinitialisation et que les appels de méthode IFilter avec des paramètres non valides retournent les codes d’erreur attendus. Les programmes de la suite de tests vident également la sortie d’un fichier filtré par un gestionnaire de filtres et case activée les informations d’inscription IFilter dans le Registre.
Cette rubrique est organisée comme suit :
- Appel de ligne de commande
- Procédure de test IFilter
- Vérification de l’indexation des éléments inscrits
- Ressources supplémentaires
- Rubriques connexes
Notes
Si un nouveau gestionnaire de filtres pour un type de fichier est installé en remplacement d’une inscription de filtre existante, le programme d’installation doit enregistrer l’inscription actuelle et la restaurer si le nouveau gestionnaire de filtre est désinstallé. Il n’existe aucun mécanisme pour chaîner les filtres. Par conséquent, le nouveau gestionnaire de filtre est chargé de répliquer toutes les fonctionnalités nécessaires de l’ancien filtre.
appel de Command-Line
La suite de tests IFilter se compose de trois applications en ligne de commande : ifilttst.exe, filtdump.exeet filtreg.exe , ainsi qu’un fichier d’initialisation, ifilttst.ini.
Important
Dans Windows 7 et versions ultérieures, les filtres écrits en code managé sont explicitement bloqués. Les filtres DOIVENT être écrits dans du code natif en raison de problèmes potentiels de contrôle de version du Common Language Runtime (CLR) avec le processus dans lequel plusieurs compléments s’exécutent.
ifilttst.exe
Le programme ifilttst.exe exécute plusieurs tests pour valider un gestionnaire de filtre. L’exemple suivant montre comment appeler le programme ifilttst.exe à partir de la ligne de commande :
ifilttst /i test.htm /l /d /v 1
L’exemple effectue les tâches suivantes :
- Indique au programme de filtrer le fichier test.htm
- Redirige les messages du journal vers test.htm.log
- Redirige les messages de vidage vers test.htm.dmp
- Définit le détail sur 1
Pour que la commande précédente fonctionne, trois fichiers doivent se trouver dans le répertoire de travail actuel : test.htm, ifilttst.exeet ifilttst.ini. Les commutateurs de ligne de commande sont répertoriés dans le tableau suivant.
| Basculer et variables possibles | Description |
|---|---|
| Nom du fichier /i | Fichier ou répertoire d’entrée à filtrer. Le nom de fichier peut contenir les caractères * génériques et ?. |
| /L | Les messages de journal sont dirigés vers un fichier au lieu de l’écran. Les messages de journal décrivent les tests individuels effectués et les résultats de réussite/échec des tests. Le nom du fichier journal est identique au nom du fichier d’entrée, mais avec une extension .log. |
| /d | Les messages de vidage sont dirigés vers un fichier au lieu de l’écran. Les messages de vidage décrivent le contenu des segments. La structure de segment est vidée lorsque le niveau de détail est 3. Le nom du fichier de vidage est identique au nom du fichier d’entrée, mais avec une extension .dmp. |
| /-L | Désactivez la journalisation. Cet indicateur remplace le /l commutateur. |
| /-D | Désactivez le dumping. Cet indicateur remplace le /d commutateur. |
| /v entier | Niveau de commentaires. La valeur par défaut est 3.
|
| /t entier | Nombre de threads à lancer. La valeur par défaut est 1. |
| /r integer] | Filtre de manière récursive les sous-répertoires. Le paramètre entier facultatif spécifie la profondeur à laquelle exercer la récursivité. Si aucun entier n’est spécifié ou si l’entier est 0, la récursivité complète est supposée. Par défaut, la profondeur de récursion est de 1. |
| /c entier | Nombre de fois à boucler. Si l’entier est 0, le test boucle à l’infini. Par défaut, le test ne boucle qu’une seule fois. |
Notes
Vous devez inclure un espace entre le commutateur de ligne de commande et la valeur.
filtdump.exe
Le programme filtdump.exe charge un gestionnaire de filtres pour un document spécifié et imprime la sortie produite par la DLL IFilter . L’exemple suivant montre comment appeler le programme filtdump.exe.
filtdump filename.ext
Filtdump.exe utilise la méthode ILoadFilter::LoadIFilter pour charger la DLL IFilter appropriée pour l’extension de nom de fichier spécifiée et imprime les résultats. Par exemple, la commande suivante indique à filtdump.exe de charger le gestionnaire de filtre smpfilt.dll pour l’extension .smp, d’extraire tout le texte et les propriétés du fichier myfile.smp et d’imprimer les résultats.
filtdump myfile.smp
filtreg.exe
Le programme filtreg.exe inspecte les informations d’installation d’IFilter dans le Registre. Vous appelez le programme filtreg.exe à partir de la ligne de commande en tapant son nom, comme dans l’exemple suivant.
filtreg
Filtreg.exe énumère toutes les extensions de nom de fichier associées à des gestionnaires de filtres en imprimant l’extension de nom de fichier et le nom de la DLL IFilter pour l’extension. Il s’agit d’un moyen simple de vérifier l’installation correcte d’un IFilter.
ifilttst.ini
Une interface IFilter est initialisée en appelant la méthode IFilter::Init . La méthode IFilter::Init prend les quatre paramètres suivants :
- grfFlags
- cAttributes
- aAttributes
- pdwFlags
L’utilisateur du programme ifilttst.exe de la suite de tests IFilter peut spécifier les valeurs de ces paramètres dans un fichier appelé ifilttst.ini. Le tableau suivant décrit les entrées du fichier ifilttst.ini qui spécifient les trois premiers paramètres (les paramètres d’entrée). Pour obtenir un exemple de fichier, consultez Exemple de fichier ifilttst.ini.
Notes
Il n’existe aucune entrée de table pour le paramètre pdwFlags , car il s’agit d’un paramètre de sortie ; il n’a pas besoin d’avoir de valeur spéciale avant l’appel à la méthode IFilter::Init .
| Entrée | Description | |
|---|---|---|
| Indicateurs | Les noms des indicateurs IFILTER_INIT qui doivent être joints par l’opérateur OR pour former le paramètre grfFlags de la méthode IFilter::Init . Les noms d’indicateurs doivent tous être en majuscules et sur la même ligne. | |
| cAttributes | Entier décimal représentant la valeur du paramètre cAttributes . | |
| aAttributes | Cette entrée doit commencer par unAttributes et doit être différente des autres entrées aAttributes dans la section. Les noms légaux de l’entrée aAttributes sont : aAttributes, aAttributes1, aAttributes2, etc. Le premier jeton doit être un GUID. Le GUID doit être mis en forme exactement comme illustré dans la [Test3] section de l’exemple de fichier ifilttst.ini. Le deuxième jeton peut être un identificateur de propriété (PID) constitué d’un nombre en notation hexadécimale ou un pointeur vers une chaîne de caractères larges (lpwstr). Une lpwstr peut être spécifiée en plaçant la chaîne entre guillemets doubles, comme illustré dans la [Test6] section de l’exemple de fichier ifilttst.ini. |
Si les entrées Flags et cAttributes ne sont pas spécifiées, la valeur par défaut est 0. Si vous définissez cAttributes égal à 2, vous devez spécifier deux noms aAttributes . Dans la [Test5] section de l’exemple, cAttributes a la valeur 1, mais aucun attribut aAttributes n’a été spécifié. Le test appelle ensuite la méthode IFilter::Init avec cAttributes égal à 1 et aAttributes égal à NULL. Il s’agit d’un cas de test utile, car il est susceptible de provoquer une violation d’accès dans la méthode IFilter::Init .
Si ifilttst.exe ne trouve pas de fichier nommé ifilttst.ini dans le répertoire de travail, une configuration par défaut est utilisée pour initialiser l’objet IFilter::Init . L’exemple suivant illustre la configuration par défaut.
[default]
grfFlags = IFILTER_INIT_APPLY_INDEX_ATTRIBUTES
cAttributes = 0
Exemple de fichier ifilttst.ini
Le fichier ifilttst.ini est organisé en sections, avec le nom de la section entre crochets. Dans l’exemple, les sections sont nommées [Test1], [Test2], et ainsi de suite. Tous les noms de section doivent être uniques. Le test lit les valeurs de la première section et initialise iFilter avec ces valeurs. Tous les tests sont ensuite exécutés à l’aide de cette configuration IFilter . Ensuite, l’IFilter est libéré et réinitialisé, à l’aide des paramètres répertoriés ci-dessus. Le processus est répété jusqu’à ce que toutes les configurations soient testées.
; Only extract text from the object
[Test1]
Flags =
cAttributes = 0
// Get all attributes (text-type and internal value-type properties.
[Test2]
Flags = IFILTER_INIT_APPLY_INDEX_ATTRIBUTES
cAttributes = 0
// This also extracts just text from the object (the GUID is PSGUID_STORAGE, and the propid is
// PID_STG_CONTENTS).
[Test3]
Flags = IFILTER_INIT_CANON_PARAGRAPHS IFILTER_INIT_HARD_LINE_BREAKS
cAttributes = 1
aAttributes1 = b725f130-47ef-101a-a5f1-02608c9eebac 13
// Only extract requested attribute from the html object (the GUID corresponds to the HTML IFilter.
[Test4]
Flags = IFILTER_INIT_CANON_HYPHENS IFILTER_INIT_CANON_SPACES
cAttributes = 1
aAttributes1 = 70eb7a10-55d9-11cf-b75b-00aa0051fe20 2
// Question: what happens if cAttributes is nonzero, but aAttributes is empty?
[Test5]
Flags = IFILTER_INIT_CANON_SPACES IFILTER_INIT_APPLY_INDEX_ATTRIBUTES IFILTER_INIT_APPLY_OTHER_ATTRIBUTES
cAttributes = 1
// Here is an attribute with a lpwstr instead of a propid (the lpwstr is enclosed in quotes).
// The GUID corresponds to the meta tag clsid for the HTML IFilter.
[Test6]
Flags =
cAttributes = 1
aAttributes1 = D1B5D3F0-C0B3-11CF-9A92-00A0C908DBF1 "GENERATOR"
Procédure de test IFilter
Une fois l’IFilter initialisé, le programme ifilttst.exe effectue une série de tests sur l’IFilter. En plus de suivre les procédures de test IFilter , assurez-vous que votre implémentation IFilter utilise des pratiques de code sécurisées. Consultez « Pratiques de code sécurisées pour Windows Search » dans Implémentation de gestionnaires de filtres dans Windows Search.
Validation Test
Le test de validation passe l’objet un bloc à la fois, en vérifiant chaque bloc individuel et tous les codes de retour. Le test de validation enregistre toutes les structures STAT_CHUNK retournées dans une liste.
Le test de validation vérifie les conditions suivantes :
- STAT_CHUNK. Les ID de bloc idChunk doivent être uniques et croissants.
- STAT_CHUNK. le paramètre flags est un état de bloc reconnu, tel que CHUNKSTATE, CHUNK_TEXT ou des constantes CenabledHUNK_VALUE.
- STAT_CHUNK. Le paramètre breakType est un type d’arrêt reconnu (0, 1, 2, 3, 4).
- Si les attributs d’initialisation IFilter spécifient que l’IFilter doit retourner uniquement des blocs contenant des propriétés de type valeur internes, idChunkSource doit être égal à 0.
- Si le bloc n’est pas dérivé, s’il ne s’agit pas d’une propriété de type valeur interne, STAT_CHUNK. idChunkSource doit être égal STAT_CHUNK. idChunk.
- IFilter::GetChunk retourne S_OK ou toute autre valeur de retour acceptable, telle que FILTER_E_END_OF_CHUNKS, FILTER_E_LINK_UNAVAILABLE, etc.
- Si le bloc contient du texte, IFilter::GetText retourne S_OK, FILTER_S_LAST_TEXT ou FILTER_E_NO_MORE_TEXT.
- Si IFilter::GetText retourne FILTER_S_LAST_TEXT, l’appel suivant à IFilter::GetText retourne FILTER_E_NO_MORE_TEXT.
- Si le bloc contient une valeur, IFilter::GetValue retourne S_OK ou FILTER_E_NO_MORE_VALUES.
Test de cohérence
Le programme ifilttxt.exe réin initialise l’interface IFilter avec les mêmes paramètres que dans le test de validation et effectue un test de cohérence. Si l’implémentation IFilter a été initialisée avec l’indicateur IFILTER_INIT_INDEXING_ONLY IFILTER_INIT , le test libère l’interface IFilter et la lie à nouveau avant d’effectuer un autre appel à la méthode IFilter::Init .
Le test de cohérence vérifie les conditions suivantes :
- Chaque structure STAT_CHUNK retournée par la méthode IFilter::GetChunk est identique à la STAT_CHUNK correspondante retournée dans le test de validation.
- IFilter::GetChunk retourne S_OK ou toute autre valeur de retour acceptable, telle que FILTER_E_END_OF_CHUNKS, FILTER_E_LINK_UNAVAILABLE, etc.
Test d’entrée non valide
Le programme ifilttst.exe réinitialise l’interface IFilter avec les mêmes paramètres et effectue un test d’entrée non valide. Ce test effectue les étapes du document un bloc à la fois en effectuant des appels de fonction incorrects, comme l’appel de la méthode IFilter::GetValue lorsque le chuck actuel contient du texte. Le test vérifie la conformité de tous les codes de retour avec la spécification IFilter .
Le test d’entrée non valide vérifie les conditions suivantes :
- Si le bloc actuel contient du texte, IFilter::GetValue retourne FILTER_E_NO_VALUES et un appel à IFilter::GetText réussit.
- Si le bloc actuel contient une valeur, IFilter::GetText retourne FILTER_E_NO_TEXT et un appel à IFilter::GetValue réussit.
- Si l’appel précédent à IFilter::GetText a retourné FILTER_E_NO_MORE_TEXT, les appels successifs à IFilter::GetText retournent FILTER_E_NO_MORE_TEXT.
- Si l’appel précédent à IFilter::GetValue a renvoyé FILTER_E_NO_MORE_VALUES, les appels successifs à IFilter::GetValue retournent FILTER_E_NO_MORE_VALUES.
- Si l’appel précédent à IFilter::GetChunk a renvoyé FILTER_E_END_OF_CHUNKS, les appels successifs à IFilter::GetChunk retournent FILTER_E_END_OF_CHUNKS.
Notes
Le test d’entrée non valide compare les structures de blocs actuelles à celles retournées dans le test de validation pour s’assurer qu’elles sont identiques.
Test de différentes configurations IFilter
Le programme ifilttst.exe libère l’interface IFilter et se relie à nouveau, en l’initialisant cette fois avec l’ensemble de paramètres suivant. Le test répète le cycle : test de validation, test de cohérence et test d’entrée non valide, jusqu’à ce que toutes les configurations IFilter souhaitées spécifiées dans ifilttst.ini fichier aient été testées.
Vérification de l’indexation des éléments inscrits
Le test final de votre IFilter garantit que votre IFilter est correctement inscrit et qu’il est appelé pour indexer les éléments que vous avez inscrits pour l’utiliser. Vous pouvez utiliser le Gestionnaire de catalogue pour lancer la réindexation, ou utiliser le Gestionnaire d’étendues d’analyse (CSM) pour configurer des règles par défaut indiquant les URL que vous souhaitez que l’indexeur analyse. Une fois l’indexation terminée, utilisez l’interface utilisateur Windows Search pour rechercher une chaîne dans le contenu ou les propriétés des éléments. Si les éléments ont été indexés, ils apparaissent dans les résultats de la recherche.
Pour plus d’informations sur la réindexation, consultez Utilisation du Gestionnaire de catalogue et Utilisation du Gestionnaire d’étendues d’analyse. L’exemple de code ReindexMatchingUrls montre comment spécifier les fichiers à réindexer et comment. L’exemple de code CrawlScopeCommandLine montre comment définir des options de ligne de commande pour les opérations d’indexation du Gestionnaire d’étendues d’analyse (CSM). Les deux exemples de code sont disponibles sur GitHub.
Exemple de fichier journal
Sur demande, le programme Ifilttst.exe peut produire un journal contenant une description des étapes qu’il effectue pendant l’exécution. Les exemples suivants sont des extraits d’un fichier journal, avec la verbosité définie sur la valeur la plus élevée possible 3.
1. INFO----**** New configuration ****
2.
3. Section name : Test2
4. grfFlags : 63
5. cAttributes : 0
6. aAttributes : NONE
7. pdwFlags : 0
8.
9. INFO----Successfully bound filter.
10.
11. PASS----Init() returned a valid value for pdwFlags.
12.
13. INFO----Successfully initialized filter.
14.
15. INFO----Performing validation test. In this part of the test, the chunks structures
16. returned by the IFilter are checked for correctness, and the return values
17. of the IFilter calls are checked.
18.
19. PASS----GetChunk() succeeded.
20.
21. PASS----The current chunk has a legal value for the flags field.
La première ligne est un message d’information indiquant qu’une nouvelle configuration a été chargée à partir du fichier ifilttst.ini. La ligne (3) indique le nom de section dans le fichier ifilttst.ini à partir duquel la configuration actuelle a été lue. Les lignes (4) à (7) répertorient les paramètres de IFilter::Init. Les lignes commençant par INFO sont des messages d’information sur la liaison du IFilter et le début du test de validation. Les lignes commençant par PASS sont des messages concernant des tests spécifiques qui ont réussi.
La ligne de l’exemple de journal suivant est un avertissement. Les avertissements attirent l’attention sur le comportement d’IFilter qui est problématique, bien que légal. Cet avertissement indique que la méthode IFilter::GetChunk a retourné un bloc de texte qui ne contient aucun texte.
WARNING-First call to GetText() returned FILTER_E_NO_MORE_TEXT.
L’exemple de message d’erreur suivant indique que l’IFilter a émis un bloc qui n’a pas été demandé.
ERROR---The IFilter has emitted a chunk which it was not requested to emit.
Check the initialization parameters in section Test1 of the initialization file.
INFO----Current chunk propid : 0x5
Dans le cas de cet exemple de message d’erreur, l’IFilter a émis un bloc avec un PID de 0x5. L’inspection de la section [Test1] dans ifilttst.ini montre que l’IFilter a été configuré pour ne pas émettre de blocs avec ce PID. Par exemple, si ni IFILTER_INIT_APPLY_INDEX_ATTRIBUTES ni IFILTER_INIT_APPLY_OTHER_ATTRIBUTES n’ont été spécifiés dans l’entrée Indicateurs et si cAttributes était 0, IFilter émet uniquement des blocs avec un PID 0x13 et correspondant à PID_STG_CONTENTS.
Exemple de fichier de vidage
Sur demande, le programme Ifilttst.exe peut produire un vidage contenant les blocs qu’il trouve et leur contenu. L’exemple suivant est un extrait d’un tel fichier de vidage.
1. Chunk ID: ........... 2
2. Chunk Break Type: ... END OF SENTENCE
3. Chunk State: ........ TEXT
4. Chunk Locale: ....... 0x411
5. Chunk Source ID: .... 2
6. Chunk Start Source .. 0x0
7. Chunk Length Source . 0x0
8. GUID ................ b725f130-47ef-101a-a5f1-02608c9eebac
9. Property ID ......... 0x13
10. This is a HTML IFilter test page
11. Chunk ID: ........... 3
12. Chunk Break Type: ... END OF SENTENCE
13. Chunk State: ........ TEXT
14. Chunk Locale: ....... 0x411
15. Chunk Source ID: .... 2
16. Chunk Start Source .. 0x0
17. Chunk Length Source . 0x0
18. GUID ................ f29f85e0-4ff9-1068-ab91-08002b27b3d9
19. Property ID ......... 0x2
20. This is a HTML IFilter test page
21. Chunk ID: ........... 4
22. Chunk Break Type: ... END OF SENTENCE
23. Chunk State: ........ VALUE
24. Chunk Locale: ....... 0x411
25. Chunk Source ID: .... 2
26. Chunk Start Source .. 0x0
27. Chunk Length Source . 0x0
28. GUID ................ f29f85e0-4ff9-1068-ab91-08002b27b3d9
29. Property ID ......... 0x2
30. This is an HTML IFilter test page
Les neuf premières lignes décrivent la structure de bloc actuelle. Le GUID et le PID correspondent à PSGUID_STORAGE/PID_STG_CONTENTS. Il s’agit d’un bloc contenant du texte brut. Le texte se trouve dans la structure de blocs suivante :
10. This is an HTML IFilter test page
Le bloc suivant, à partir de la ligne 11, a un GUID différent, correspondant à , HTML IFilteret un PID différent, correspondant à un HREF HTML. Il s’agit d’une propriété de type valeur interne, exportée par le HTML IFilter.
Le bloc suivant, à partir de la ligne 21, a le même GUID et le même PID, mais son état de bloc est VALUE au lieu de TEXT. Notez que le texte de ces deux derniers blocs est le même que pour le premier bloc. Toutefois, étant donné que IFilter est conçu pour trois attributs (texte brut, HTML HREF en tant que texte et HTML HREF en tant que valeur) à appliquer à cette expression, les résultats sont émis en trois blocs distincts.
Ressources supplémentaires
- L’exemple de code IFilterSample , disponible sur GitHub, montre comment créer une classe de base IFilter pour implémenter l’interface IFilter .
- Pour obtenir une vue d’ensemble du processus d’indexation, consultez Processus d’indexation.
- Pour obtenir une vue d’ensemble des types de fichiers, consultez Types de fichiers.
- Pour interroger les attributs d’association de fichiers d’un type de fichier, consultez PerceivedTypes, SystemFileAssociations et Inscription d’application.
Rubriques connexes
Développement de gestionnaires de filtres
À propos des gestionnaires de filtres dans Windows Search
Meilleures pratiques pour la création de gestionnaires de filtres dans Windows Search
Retour de propriétés à partir d’un gestionnaire de filtres
Gestionnaires de filtre fournis avec Windows
Implémentation de gestionnaires de filtres dans Windows Search