aboutsummaryrefslogtreecommitdiff
path: root/chrome/content/code/redirect.js
blob: c4fddf80d0397c700366665e3ecc7c1625d2d2f7 (plain)
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
//// $Id$

Components.utils.import("resource://gre/modules/XPCOMUtils.jsm");


function Redirect(exampleUrl, includePattern, redirectUrl, patternType, excludePattern, unescapeMatches, disabled) {
	this._init(exampleUrl, includePattern, redirectUrl, patternType, excludePattern, unescapeMatches, disabled);
}

//Static
Redirect.WILDCARD = 'W';
Redirect.REGEX = 'R';

Redirect.prototype = {

	// rdIRedirect implementation
	
	//attributes
	exampleUrl : null,
			
	get includePattern() { return this._includePattern; },
	set includePattern(value) { 
		this._includePattern = value;
		this._rxInclude = this._compile(value); 
	},
	
	get excludePattern() { return this._excludePattern; },
	set excludePattern(value) { 
		this._excludePattern = value; 
		this._rxExclude = this._compile(value); 
	},
	
	redirectUrl : null,
	
	get patternType() { return this._patternType; },
	set patternType(value) { 
		this._patternType = value;
		this.compile();
	},

	unescapeMatches : false,
	
	disabled : false,
	
	//Functions
    clone : function() {
		return new Redirect(this.exampleUrl, this.includePattern, 
							this.redirectUrl, this.patternType, 
							this.excludePattern, this.unescapeMatches,
							this.disabled);    
    },
    
	compile : function() {
		this._rxInclude = this._compile(this._includePattern); 
		this._rxExclude = this._compile(this._excludePattern); 
	},

	copyValues : function(other) {
		this.exampleUrl = other.exampleUrl;
		this.includePattern = other.includePattern;
		this.excludePattern = other.excludePattern;
		this.redirectUrl = other.redirectUrl;
		this.patternType = other.patternType;
		this.unescapeMatches = other.unescapeMatches;
		this.disabled = other.disabled;
    },

	deserialize : function(str) {
		if (!str || !str.split) {
			throw Error("Invalid serialized redirect: " + str);
		}	
		var parts = str.split(',,,');
		if (parts.length < 5) {
			throw Error("Invalid serialized redirect, too few fields: " + str);
		}
		this._init.apply(this, parts);
	},
	
    equals : function(redirect) {
		return this.exampleUrl == redirect.exampleUrl
			&& this.includePattern == redirect.includePattern
			&& this.excludePattern == redirect.excludePattern
			&& this.redirectUrl == redirect.redirectUrl
			&& this.patternType == redirect.patternType
			&& this.unescapeMatches == redirect.unescapeMatches
		;
    },
	
	getMatch: function(url) {
		var result = { 
			isMatch : false, 
			isExcludeMatch : false, 
			isDisabledMatch : false, 
			redirectTo : '',
			toString : function() { return "{ isMatch : " + this.isMatch + 
			                               ", isExcludeMatch : " + this.isExcludeMatch + 
			                               ", isDisabledMatch : " + this.isDisabledMatch + 
			                               ", redirectTo : \"" + this.redirectTo + "\"" +
			                               "}"; }
		};
		var redirectTo = null;

		redirectTo = this._includeMatch(url);
        if (redirectTo !== null) {
	        if (this.disabled) {
				result.isDisabledMatch = true;
			} else if (this._excludeMatch(url)) {
	            result.isExcludeMatch = true;
		  	} else {
	         	result.isMatch = true;
	         	result.redirectTo = redirectTo;
	        }
        }
     	return result;   
	},
	
	isRegex: function() {
		return this.patternType == Redirect.REGEX;
	},
	
	isWildcard : function() {
		return this.patternType == Redirect.WILDCARD;	
	},

	serialize : function() {
		return [ this.exampleUrl
			   , this.includePattern
			   , this.redirectUrl
			   , this.patternType
			   , this.excludePattern
			   , this.unescapeMatches
			   , this.disabled ].join(',,,');
	},
	
	test : function() {
		return this.getMatch(this.exampleUrl);	
	},

	//end rdIRedirect
	
	//nsISupports
	QueryInterface : XPCOMUtils.generateQI([Components.interfaces.rdIRedirect]),
	
	//end nsISupports
	
	//Private functions below	

	_includePattern : null,
	_excludePattern : null,
	_patternType : null,
	_rxInclude : null,
	_rxExclude : null,
	
	_preparePattern : function(pattern) {
		if (this.patternType == Redirect.REGEX) {
			return pattern;	
		} else { //Convert wildcard to regex pattern
			var converted = '^';
			for (var i = 0; i < pattern.length; i++) {
				var ch = pattern.charAt(i);
				if ('()[]{}?.^$\\+'.indexOf(ch) != -1) {
					converted += '\\' + ch;
				} else if (ch == '*') {
					converted += '(.*?)';
				} else {
					converted += ch;
				}
			}
			converted += '$';
			return converted;
		}
	},

	_compile : function(pattern) {
		if (!pattern) {
			return null;
		}
		return new RegExp(this._preparePattern(pattern),"gi");
	},
	
	_init : function(exampleUrl, includePattern, redirectUrl, patternType, excludePattern, unescapeMatches, disabled) {
		this.exampleUrl = exampleUrl || '';
		this.includePattern = includePattern || '';
		this.excludePattern = excludePattern || '';
		this.redirectUrl = redirectUrl || '';
		this.patternType = patternType || Redirect.WILDCARD;
		this.unescapeMatches = (unescapeMatches === 'true' || unescapeMatches === true);
		this.disabled = (disabled === 'true' || disabled === true);
	},
	
	toString : function() {
		return 'REDIRECT: {'
			+  '\n\tExample url      : ' + this.exampleUrl
			+  '\n\tInclude pattern  : ' + this.includePattern
			+  '\n\tExclude pattern  : ' + this.excludePattern
			+  '\n\tRedirect url     : ' + this.redirectUrl
			+  '\n\tPattern type     : ' + this.patternType
			+  '\n\tUnescape matches : ' + this.unescapeMatches
			+  '\n\tDisabled         : ' + this.disabled
			+  '\n}\n';
	},
	
	_includeMatch : function(url) {
		if (!this._rxInclude) {
			return null;
		}	
		var matches = this._rxInclude.exec(url);
		if (!matches) {
			return null;
		}
		var resultUrl = this.redirectUrl;
        for (var i = 1; i < matches.length; i++) {
            resultUrl = resultUrl.replace(new RegExp('\\$' + i, 'gi'), this.unescapeMatches ? unescape(matches[i]) : matches[i]);
        }
        this._rxInclude.lastIndex = 0;
        return resultUrl;
	},
	
	_excludeMatch : function(url) {
		if (!this._rxExclude) {
			return false;	
		}
		var shouldExclude = !!this._rxExclude.exec(url);	
		this._rxExclude.lastIndex = 0;
		return shouldExclude;
	}
};