Confirmed users
1,041
edits
Extension Blocklisting:Code Design: Difference between revisions
Jump to navigation
Jump to search
Extension Blocklisting:Code Design (view source)
Revision as of 21:42, 18 February 2006
, 18 February 2006→Blacklist syntax
| Line 9: | Line 9: | ||
== Blacklist syntax == | == Blacklist syntax == | ||
* The blacklist file has a flexible xml syntax that will use default values for values that are not specified. All Extension Manager items must be children of <tt>emItems</tt> in order to ease the use of this file for additional blacklist items such as plugins that are not | * The blacklist file has a flexible xml syntax that will use default values for values that are not specified. All Extension Manager items must be children of <tt>emItems</tt> in order to ease the use of this file for additional blacklist items such as plugins that are not managed by the Extension Manager. | ||
Examples: | Examples: | ||
| Line 57: | Line 57: | ||
* All versions of the <tt>item_4@domain</tt> Extension Manager item will be blacklisted if the current application version is between <tt>1.5</tt> and <tt>1.5.*</tt> (e.g. less than <tt>1.6</tt>). | * All versions of the <tt>item_4@domain</tt> Extension Manager item will be blacklisted if the current application version is between <tt>1.5</tt> and <tt>1.5.*</tt> (e.g. less than <tt>1.6</tt>). | ||
* All versions of the <tt>item_5@domain</tt> Extension Manager item will be blacklisted for all version of the current application. | * All versions of the <tt>item_5@domain</tt> Extension Manager item will be blacklisted for all version of the current application. | ||
As can be seen it is possible to blacklist all version of an extension for all versions of an application as well as any combination of application id's along with version ranges for both the extension id and application id. Also, by not specifying a value and instead using the default value it is possible to lessen the size of the blacklist xml file. This is possible by using the following defaults: | |||
* <tt>minVersion</tt> = 0 | |||
* <tt>maxVersion</tt> = * | |||
* <tt>targetApplication</tt> <tt>id</tt> = current application <tt>id</tt> | |||
At first glance it may seem more appropriate to use a plain text file and parse delimited values. The draw back of this method are that extension id's and application id's would have to be specified multiple times whereas with this format we are able to specify each extension id one time only and each application id for an extension id one time only. | |||
If an extension's metadata matches all of the conditions it will be blacklisted and no further checking for that extension will be performed. This allows handling of overlapping ranges though there has been no use case for supporting overlapping ranges. | |||
Support for a <tt>targetApplication</tt> <tt>id</tt> of <tt>toolkit@mozilla.org</tt> has been added since this will be necessary after [https://bugzilla.mozilla.org/show_bug.cgi?id=299716 Bug 299716] is fixed. | |||
We will be using individual blacklist files for each application in order to not penalize one application that has few or no blacklist items with the blacklist for an application that contains numerous blacklisted items. | |||