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
203
|
/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et: */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Jetpack.
*
* The Initial Developer of the Original Code is
* the Mozilla Foundation.
* Portions created by the Initial Developer are Copyright (C) 2010
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Irakli Gozalishvili <gozala@mozilla.com> (Original Author)
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
"use strict";
const { EventEmitter } = require('../events');
const { validateOptions, getTypeOf } = require('../api-utils');
const { URL, toFilename } = require('../url');
const file = require('../file');
// map of property validations
const valid = {
contentURL: {
ok: function (value) {
try {
URL(value);
}
catch(e) {
return false;
}
return true;
},
msg: 'The `contentURL` option must be a valid URL.'
},
contentScriptFile: {
is: ['undefined', 'null', 'string', 'array'],
map: function(value) 'undefined' === getTypeOf(value) ? null : value,
ok: function(value) {
if (getTypeOf(value) === 'array') {
// Make sure every item is a local file URL.
return value.every(function (item) {
try {
toFilename(item);
return true;
}
catch(e) {
return false;
}
});
}
return true;
},
msg: 'The `contentScriptFile` option must be a local file URL or an array of'
+ 'URLs.'
},
contentScript: {
is: ['undefined', 'null', 'string', 'array'],
map: function(value) 'undefined' === getTypeOf(value) ? null : value,
ok: function(value) 'array' !== getTypeOf(value) ? true :
value.every(function(item) 'string' === getTypeOf(item))
,
msg: 'The script option must be a string or an array of strings.'
},
contentScriptWhen: {
is: ['string'],
ok: function(value) ['start', 'ready', 'end'].indexOf(value) >= 0,
map: function(value) {
return value || 'end';
},
msg: 'The `contentScriptWhen` option must be either "start", "ready" or "end".'
}
};
exports.validationAttributes = valid;
/**
* Shortcut function to validate property with validation.
* @param {Object|Number|String} suspect
* value to validate
* @param {Object} validation
* validation rule passed to `api-utils`
*/
function validate(suspect, validation) validateOptions(
{ $: suspect },
{ $: validation }
).$
function Allow(script) ({
get script() script,
set script(value) script = !!value
})
/**
* Trait is intended to be used in some composition. It provides set of core
* properties and bounded validations to them. Trait is useful for all the
* compositions providing high level APIs for interaction with content.
* Property changes emit `"propertyChange"` events on instances.
*/
const Loader = EventEmitter.compose({
/**
* Permissions for the content, with the following keys:
* @property {Object} [allow = { script: true }]
* @property {Boolean} [allow.script = true]
* Whether or not to execute script in the content. Defaults to true.
*/
get allow() this._allow || (this._allow = Allow(true)),
set allow(value) this.allow.script = value && value.script,
_allow: null,
/**
* The content to load. Either a string of HTML or a URL.
* @type {String}
*/
get contentURL() this._contentURL,
set contentURL(value) {
value = validate(value, valid.contentURL);
if (this._contentURL != value) {
this._emit('propertyChange', {
contentURL: this._contentURL = value
});
}
},
_contentURL: null,
/**
* When to load the content scripts.
* Possible values are "end" (default), which loads them once all page
* contents have been loaded, "ready", which loads them once DOM nodes are
* ready (ie like DOMContentLoaded event), and "start", which loads them once
* the `window` object for the page has been created, but before any scripts
* specified by the page have been loaded.
* Property change emits `propertyChange` event on instance with this key
* and new value.
* @type {'start'|'ready'|'end'}
*/
get contentScriptWhen() this._contentScriptWhen,
set contentScriptWhen(value) {
value = validate(value, valid.contentScriptWhen);
if (value !== this._contentScriptWhen) {
this._emit('propertyChange', {
contentScriptWhen: this._contentScriptWhen = value
});
}
},
_contentScriptWhen: 'end',
/**
* The URLs of content scripts.
* Property change emits `propertyChange` event on instance with this key
* and new value.
* @type {String[]}
*/
get contentScriptFile() this._contentScriptFile,
set contentScriptFile(value) {
value = validate(value, valid.contentScriptFile);
if (value != this._contentScriptFile) {
this._emit('propertyChange', {
contentScriptFile: this._contentScriptFile = value
});
}
},
_contentScriptFile: null,
/**
* The texts of content script.
* Property change emits `propertyChange` event on instance with this key
* and new value.
* @type {String|undefined}
*/
get contentScript() this._contentScript,
set contentScript(value) {
value = validate(value, valid.contentScript);
if (value != this._contentScript) {
this._emit('propertyChange', {
contentScript: this._contentScript = value
});
}
},
_contentScript: null
});
exports.Loader = Loader;
|
