1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/*
* This file is part of Adblock Plus <https://adblockplus.org/>,
* Copyright (C) 2006-2017 eyeo GmbH
*
* Adblock Plus is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 3 as
* published by the Free Software Foundation.
*
* Adblock Plus 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 Adblock Plus. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @fileOverview Public Adblock Plus API.
*/
var EXPORTED_SYMBOLS = ["AdblockPlus"];
const Cc = Components.classes;
const Ci = Components.interfaces;
const Cr = Components.results;
const Cu = Components.utils;
Cu.import("resource://gre/modules/Services.jsm");
function require(module)
{
let result = {};
result.wrappedJSObject = result;
Services.obs.notifyObservers(result, "adblockplus-require", module);
return result.exports;
}
let {FilterStorage} = require("filterStorage");
let {Filter} = require("filterClasses");
let {Subscription, SpecialSubscription, RegularSubscription, DownloadableSubscription, ExternalSubscription} = require("subscriptionClasses");
const externalPrefix = "~external~";
/**
* Class implementing public Adblock Plus API
* @class
*/
var AdblockPlus =
{
/**
* Returns current subscription count
* @type Integer
*/
get subscriptionCount()
{
return FilterStorage.subscriptions.length;
},
/**
* Gets a subscription by its URL
*/
getSubscription: function(/**String*/ id) /**IAdblockPlusSubscription*/
{
if (id in FilterStorage.knownSubscriptions)
return createSubscriptionWrapper(FilterStorage.knownSubscriptions[id]);
return null;
},
/**
* Gets a subscription by its position in the list
*/
getSubscriptionAt: function(/**Integer*/ index) /**IAdblockPlusSubscription*/
{
if (index < 0 || index >= FilterStorage.subscriptions.length)
return null;
return createSubscriptionWrapper(FilterStorage.subscriptions[index]);
},
/**
* Updates an external subscription and creates it if necessary
*/
updateExternalSubscription: function(/**String*/ id, /**String*/ title, /**Array of Filter*/ filters) /**String*/
{
if (id.substr(0, externalPrefix.length) != externalPrefix)
id = externalPrefix + id;
let subscription = Subscription.knownSubscriptions[id];
if (typeof subscription == "undefined")
subscription = new ExternalSubscription(id, title);
subscription.lastDownload = parseInt(new Date().getTime() / 1000);
let newFilters = [];
for (let filter of filters)
{
filter = Filter.fromText(Filter.normalize(filter));
if (filter)
newFilters.push(filter);
}
if (id in FilterStorage.knownSubscriptions)
FilterStorage.updateSubscriptionFilters(subscription, newFilters);
else
{
subscription.filters = newFilters;
FilterStorage.addSubscription(subscription);
}
return id;
},
/**
* Removes an external subscription by its identifier
*/
removeExternalSubscription: function(/**String*/ id) /**Boolean*/
{
if (id.substr(0, externalPrefix.length) != externalPrefix)
id = externalPrefix + id;
if (!(id in FilterStorage.knownSubscriptions))
return false;
FilterStorage.removeSubscription(FilterStorage.knownSubscriptions[id]);
return true;
},
/**
* Adds user-defined filters to the list
*/
addPatterns: function(/**Array of String*/ filters)
{
for (let filter of filters)
{
filter = Filter.fromText(Filter.normalize(filter));
if (filter)
{
filter.disabled = false;
FilterStorage.addFilter(filter);
}
}
},
/**
* Removes user-defined filters from the list
*/
removePatterns: function(/**Array of String*/ filters)
{
for (let filter of filters)
{
filter = Filter.fromText(Filter.normalize(filter));
if (filter)
FilterStorage.removeFilter(filter);
}
},
/**
* Returns installed Adblock Plus version
*/
getInstalledVersion: function() /**String*/
{
return require("info").addonVersion;
},
/**
* Returns source code revision this Adblock Plus build was created from (if available)
*/
getInstalledBuild: function() /**String*/
{
return "";
},
};
/**
* Wraps a subscription into IAdblockPlusSubscription structure.
*/
function createSubscriptionWrapper(/**Subscription*/ subscription) /**IAdblockPlusSubscription*/
{
if (!subscription)
return null;
return {
url: subscription.url,
special: subscription instanceof SpecialSubscription,
title: subscription.title,
autoDownload: true,
disabled: subscription.disabled,
external: subscription instanceof ExternalSubscription,
lastDownload: subscription instanceof RegularSubscription ? subscription.lastDownload : 0,
downloadStatus: subscription instanceof DownloadableSubscription ? subscription.downloadStatus : "synchronize_ok",
lastModified: subscription instanceof DownloadableSubscription ? subscription.lastModified : null,
expires: subscription instanceof DownloadableSubscription ? subscription.expires : 0,
getPatterns: function()
{
let result = subscription.filters.map(function(filter)
{
return filter.text;
});
return result;
}
};
}
|