Motifs (Match patterns)
Les modèles de correspondance sont un moyen de spécifier des groupes d'URL : un modèle de correspondance correspond à un ensemble spécifique d'URL. Ils sont destinés à des extensions à l'aide d'API WebExtensions dans quelques endroits, notamment pour spécifier les documents dans lesquels charger des content scripts, et pour spécifier les URL à ajouter aux auditeurs webRequest
.
Les API qui utilisent des modèles de correspondance acceptent généralement une liste de modèles de correspondance et effectueront les actions appropriées si l'URL correspond à l'un des motifs. Voir, par exemple, la clé content_scripts
dans manifest.json.
Structure du modèle de correspondance
Note : Certains navigateurs ne prennent pas en charge certains schémas. Consultez le tableau de compatibilité du navigateur pour plus de détails.
Tous les modèles de correspondance sont spécifiés comme des chaînes. Outre le motif spécial « <all_urls> », les modèles de correspondance se composent de trois partie : schéma, l'hôte, et le chemin d'accès. Le schéma et l'hôte sont séparés par « :// ».
<scheme>://<host><path>
schéma
Le composant du schéma peut prendre l'une des deux formes suivantes :
Valeur | Correspondances |
---|---|
* |
Seulement "http" et "https" et dans certains navigateurs "ws" et "wss" aussi. |
Une parmi http , https , ws ,
wss , ftp , ftps ,
data ou file .
|
Seulement le schéma donné. |
hôte
Le composant hôte peut prendre l'une des trois formes suivantes :
Valeur | Correspondances |
---|---|
* |
Tout hôte |
*. Suivi d'une partie du nom d'hôte |
L'hôte donné et l'un de ses sous-domaines |
Un nom d'hôte complet, sans caractères génériques | Seul l'hôte donné |
L'hôte ne doit pas inclure un numéro de port.
L'hôte est facultatif seulement si le schéma est un « fichier ».
Notez que le caractère générique ne peut apparaître qu'au début.
chemin
Le composant du chemin d'accès doit commencer par un /
.
Ensuite, il peut contenir éventuellement toute combinaison du caractère générique *
et de l'un des caractères autorisés dans les chemins d'URL ou chaînes de requête. Contrairement à l'hôte, le composant du chemin peut contenir le caractère générique *
au milieu ou à la fin, et le caractère *
peut apparaître plusieurs fois.
La valeur du chemin matches correspond à la chaîne de caractères qui est le chemin plus la chaine de requête URL. Ceci inclut le signe ?
entre les deux, si la chaîne de requête est présente dans l'URL. Par exemple, si vous voulez faire correspondre des URLs sur n'importe quel domaine où le chemin URL se termine par foo.bar
, alors vous devez utiliser un tableau de Match Patterns comme ['*://*/*foo.bar', '*://*/*foo.bar?*']
. Le ?*
est nécessaire, plutôt que juste la bar*
, afin d'ancrer la fin *
comme s'appliquant à la chaîne de requête URL et non à une partie du chemin URL.
Ni l'identificateur de fragment d'URL, ni le #
qui le précède, ne sont considérés comme faisant partie du chemin.
Note :
La chaîne de modèle de chemin d'accès ne doit pas inclure de numéro de port. Ajout d'un port, comme dans : http://localhost:1234/*
fait que le motif de match est ignoré. Cependant, http://localhost:1234
correspondra avec http://localhost/*
.
<all_urls>
La valeur spéciale <all_urls>
correspond à toutes les URL sous l'un des schémas pris en charge, c'est‐à‐dire : "http", "https", "ws", "wss", "ftp", "data" et "file".
Exemples
Modèle | Exemples de correspondances | Exemples de non-correspondances |
---|---|---|
Correspondance à toutes les URL |
|
|
Correspondance à toutes les URLs HTTP, HTTPS et WebSocket |
|
|
Correspondance à toutes les URLs HTTP, HTTPS et WebSocket URLs qui sont hébergés sur "mozilla.org" ou l'un de ses sous-domaines. |
|
|
Correspondance à toutes les URLs HTTP, HTTPS and WebSocket qui sont hébergés exactement chez "mozilla.org/" |
|
|
Correspondance seulement à "ftp://mozilla.org/". |
ftp://mozilla.org |
|
Correspondance aux URLs HTTPS sur n'importe quel hôte, dont le chemin est "path". |
|
|
Correspondance aux URLs HTTPS sur n'importe quel hôte, dont le chemin est "path/". |
|
|
Correspondance sur toutes les URLs HTTPS uniquement sur "mozilla.org", avec n'importe quel chemin |
|
|
Correspondance seulement pour cet URL. |
|
N'importe quoi d'autre. |
Correspondance sur toutes les URL HTTPS hébergées sur "mozilla.org",
dont le chemin d'accès contient un composant "b" quelque part au
milieu. Correspond aux URLs avec les chaînes de requête, si la chaîne
se termine par un |
|
|
Correspondance à n'importe quelle URL FILE dont le chemin commence par "blah". |
|
file:///bleh/ (chemin sans équivalent) |
Modèles de correspondance invalides
Modèle invalide | Raison |
---|---|
resource://path/ |
schéma non pris en charge. |
https://mozilla.org |
pas de chemin. |
https://mozilla.*.org/ |
"*" dans *hôte* doit être au départ. |
https://*zilla.org/ |
"*" dans *hôte* doit être le seul caractère ou être suivi de « . ». |
http*://mozilla.org/ |
"*" dans le schéma doit être le seul caractère. |
https://mozilla.org:80/ |
L'hôte ne doit pas inclure un numéro de port. |
*://* |
Chemin vide : il doit être "*://*/* ". |
file://* |
Chemin vide : il doit être "file:///* ". |
Compatibilité des navigateurs
BCD tables only load in the browser