-
Notifications
You must be signed in to change notification settings - Fork 7
/
ratings.js
452 lines (398 loc) · 12.7 KB
/
ratings.js
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
// s (NEW!) string (optional) title of a movie to search for
// i string (optional) a valid IMDb movie id
// t string (optional) title of a movie to return
// y year (optional) year of the movie
// r JSON, XML response data type (JSON default)
// plot short, full short or extended plot (short default)
// callback name (optional) JSONP callback name
// tomatoes true (optional) adds rotten tomatoes data
var IMDB_API = "http://www.omdbapi.com/?tomatoes=true";
var TOMATO_LINK = "http://www.rottentomatoes.com/alias?type=imdbid&s=";
var IMDB_LINK = "http://www.imdb.com/title/";
//popup movie selectors
var HOVER_SEL = {
'.bobbable .popLink' : getWIMainTitle, //wi main display movies
'.mdpLink' : getSideOrDVDTitle,
};
var CACHE = localStorage;
var CACHE_LIFE = 1000*60*60*24*7*2; //two weeks in milliseconds
/////////// HELPERS /////////////
/*
Builds a select object where the selector is used to insert the ratings via the given insertFunc. Interval specifies the interval necessary for the popupDelay. imdb and rt classes are extra classes that can be added to a rating.
*/
function selectObj(selector, insertFunc, interval, imdbClass, rtClass){
imdbClass = imdbClass || '';
rtClass = rtClass || '';
return {
'selector' : selector,
'insertFunc' : insertFunc,
'interval' : interval,
'imdbClass' : imdbClass,
'rtClass' : rtClass,
}
}
/*
Add the style sheet to the main netflix page.
*/
function addStyle() {
if (!$('#rating-overlay').length){
var url = chrome.extension.getURL('../css/ratings.css');
$("head").append("<link id='rating-overlay' href='" + url + "' type='text/css' rel='stylesheet' />");
}
}
/*
Get the arguments for showRating based on which popup is being overridden
*/
function getArgs() {
var url = document.location.href;
var key = 'dvd.netflix.com';
var args;
if (url.indexOf(key) != -1) { // we are in dvds
args = POPUP_INS_SEL[key];
args.key = key;
return args
}
key = 'movies.netflix.com';
var dict = POPUP_INS_SEL[key];
if (url.indexOf('Queue') != -1) {
args = dict.Queue;
args.key = 'Queue';
} else {
args = dict.Wi;
args.key = 'Wi';
}
return args
}
/*
Add item to the cache
*/
function addCache(title, imdb, tomatoMeter, tomatoUserMeter, imdbID, year) {
year = year || null;
imdb = imdb || null;
tomatoMeter = tomatoMeter || null;
tomatoUserMeter = tomatoUserMeter || null;
imdbID = imdbID || null;
var date = new Date().getTime();
var rating = {
'title' : title,
'imdb' : imdb,
'tomatoMeter' : tomatoMeter,
'tomatoUserMeter' : tomatoUserMeter,
'imdbID' : imdbID,
'year' : year,
'date' : date,
};
CACHE[title] = JSON.stringify(rating);
return rating
}
function checkCache(title) {
if(!(title in CACHE)) {
return {
'inCache' : false,
'cachedVal' : null,
}
}
var cachedVal = JSON.parse(CACHE[title]);
var inCache = false;
if (cachedVal !== undefined && cachedVal.tomatoMeter !== undefined && cachedVal.year !== null){
var now = new Date().getTime();
var lifetime = now - cachedVal.date;
if(lifetime <= CACHE_LIFE) {
inCache = true;
}
}
return {
'inCache' : inCache,
'cachedVal' : cachedVal,
}
}
/*
Helper to generalize the parser for side titles and DVD titles
*/
function getWrappedTitle(e, key, regex) {
var title = $(e.target).attr('alt');
if (title === undefined) {
var url = $(e.target).context.href;
if (typeof url === "undefined"){
return ""
}
url = url.split('/');
var title = url[url.indexOf(key) + 1];
title = title.replace(regex, ' ');
}
return title
}
/*
Clear old ratings and unused content. Differs for different popups
*/
function clearOld(args){
var $target = $('#BobMovie');
if (args.key in POPUP_INS_SEL['movies.netflix.com']){
$target.find('.label').contents().remove();
}
$target.find('.rating-link').remove();
$target.find('.ratingPredictor').remove();
}
function getTomatoClass(score) {
return score < 59 ? 'rotten' : 'fresh';
}
///////////////// URL BUILDERS ////////////////
/*
Builds and returns the imdbAPI url
*/
function getIMDBAPI(title, year) {
var url = IMDB_API + '&t=' + title;
if (year !== null) {
url += '&y=' + year;
}
return url
}
/*
Build the url for the imdbLink
*/
function getIMDBLink(title) {
return IMDB_LINK + title
}
/*
Build the url for the rtLink
*/
function getTomatoLink(imdbID) {
imdbID = imdbID.slice(2) //convert tt123456 -> 123456
return TOMATO_LINK + imdbID
}
///////////////// TITLE PARSERS ////////////////
/*
parses form: http://movies.netflix.com/WiPlayer?movieid=70171942&trkid=7103274&t=Archer
*/
function getWIMainTitle(e) {
return $(e.target).siblings('img').attr('alt');
}
/*
Cleanup recently watched title
*/
function getRecentTitle(title) {
var index = title.indexOf('%3A');
if (index !== -1) {
title = title.slice(0, index);
}
return title
}
/*
Instant Queue and dvd popups use the same selector but different parsers
*/
function getSideOrDVDTitle(e) {
var url = document.location.href;
if (url.indexOf('Search') != -1) { //no popups on search page.
return $(e.target).text() // but still cache the title
}
var key = 'dvd.netflix.com';
if (url.indexOf(key) != -1) { // we are in dvds now
return getDVDTitle(e)
}
return getSideTitle(e)
}
function getSideTitle(e) {
var key = "WiMovie";
var regex = /_/g;
return getWrappedTitle(e, key,regex)
}
function getDVDTitle(e) {
var key = "Movie";
var regex = /-/g;
return getWrappedTitle(e, key,regex)
}
function parseYear($target) {
var $target = $target || $('.year');
var year = null;
if ($target.length) {
year = $target.text().split('-')[0];
}
return year
}
/*
Parse the search title for a given search result
*/
function parseSearchTitle($target){
return $target.find('.title').children().text();
}
/////////// RATING HANDLERS ////////////
function eventHandler(e){
var title = e.data(e); //title parse funtion
if ($('.label').contents() != '') { //the popup isn't already up
getRating(title, null, null, function(rating){ //null year, null addArgs
showRating(rating, getArgs());
});
}
}
/*
Search for the title, first in the CACHE and then through the API
*/
function getRating(title, year, addArgs, callback) {
var cached = checkCache(title);
if (cached.inCache){
callback(cached.cachedVal, addArgs);
return
}
$.get(getIMDBAPI(title, year), function(res){
try {
res = JSON.parse(res);
} catch(e){
res = {
'Response' : 'False',
};
}
if (res.Response === 'False'){
addCache(title);
return null
}
var imdbScore = parseFloat(res.imdbRating);
var tomatoMeter = getTomatoScore(res, "tomatoMeter");
var tomatoUserMeter = getTomatoScore(res, "tomatoUserMeter");
var rating = addCache(title, imdbScore, tomatoMeter, tomatoUserMeter, res.imdbID, year);
callback(rating, addArgs);
});
}
/*
parse tomato rating from api response object
*/
function getTomatoScore(res, meterType) {
return res[meterType] === "N/A" ? null : parseInt(res[meterType])
}
/*
Given a rating and specific arguments, display to popup or search page
*/
function showRating(rating, args) {
if (!args.interval) { // unknown popup
return
}
var checkVisible = setInterval(function(){
var $target = $(args.selector);
if($target.length){
clearInterval(checkVisible);
updateCache(rating.title); //run the query with the year to update
clearOld(args);
displayRating(rating, args);
}
}, args.interval);
}
/*
Call the API with the year and update the rating if neccessary
*/
function updateCache(title) {
var cachedVal = checkCache(title).cachedVal;
if (cachedVal.year === null) {
var year = parseYear();
getRating(title, year, null, function(rating){
showRating(rating, getArgs());
});
}
}
/*
Build and display the ratings
*/
function displayRating(rating, args) {
var imdb = getIMDBHtml(rating, args.imdbClass);
var tomato = getTomatoHtml(rating, args.rtClass);
var $target = $(args.selector);
$target[args.insertFunc](imdb);
$target[args.insertFunc](tomato);
}
////////SEARCH AND INDIVIDUAL PAGE HANDLERS //////////
/*
Determine which search, dvd or watch instantly and display the correct ratings
*/
function searchSetup() {
var url = document.location.href;
var args;
if (url.indexOf("WiSearch") !== -1) {
args = SEARCH_SEL.WiSearch;
args.selectorClass = ".media";
} else if (url.indexOf("Search") !== -1) {
args = SEARCH_SEL.Search;
args.selectorClass = ".agMovie";
}
if (args === undefined) {
return
}
return displaySearch(args)
}
/*
Find ratings for all of the movies found by the search and display them
*/
function displaySearch(args){
var selector = args.selector;
$.each($(args.selectorClass), function(index, target){ // iterate over movies found
var $target = $(target);
var year = parseYear($target.find('.year'));
var title = parseSearchTitle($target);
var addArgs = {
'target' : $target,
'selector' : selector,
}; // add the current target so the rating matches the movie found
getRating(title, year, addArgs, function(rating, addArgs){
args.selector = addArgs.target.find(addArgs.selector); // store selector to show rating on.
displayRating(rating, args);
});
});
}
/////////// HTML BUILDERS ////////////
function getIMDBHtml(rating, klass) {
var score = rating.imdb;
var html = $('<a class="rating-link" target="_blank" href="' + escapeHTML(getIMDBLink(rating.imdbID)) + '"><div class="imdb imdb-icon star-box-giga-star" title="IMDB Rating"></div></a>');
if (!score) {
html.css('visibility', 'hidden');
} else {
html.find('.imdb').addClass(klass).append(score.toFixed(1));
}
return html
}
function getTomatoHtml(rating, klass) {
var html = $('<a class="rating-link" target="_blank" href="' + escapeHTML(getTomatoLink(rating.imdbID)) + '"><span class="tomato tomato-wrapper" title="Rotten Tomato Rating"><span class="rt-icon tomato-icon med"></span><span class="rt-score tomato-score"></span><span class="rt-icon audience-icon med"></span><span class="rt-score audience-score"></span></span></a>');
if (!rating.tomatoMeter || !rating.tomatoUserMeter) {
html.css('visibility', 'hidden');
return html
}
html.find('.tomato-icon').addClass(getTomatoClass(rating.tomatoMeter)).addClass(klass);
html.find('.tomato-score').append(rating.tomatoMeter + '%');
html.find('.audience-icon').addClass(getTomatoClass(rating.tomatoUserMeter)).addClass(klass);
html.find('.audience-score').append(rating.tomatoUserMeter + '%');
return html
}
/*
Helper function for escaping API urls
*/
function escapeHTML(str) {
return str.replace(/[&"<>]/g, function(m) {
return {
"&": "&",
'"': """,
"<": "<",
">": ">",
}[m];
});
}
///////// INIT /////////////
$(document).ready(function() {
//common select objects
var dvdSelObj = selectObj('.bobMovieRatings', 'append', 800, 'dvd-popup', 'dvd-rt-icon');
var WiObj = selectObj('.midBob', 'append', 800);
//poup select types
POPUP_INS_SEL = {
'movies.netflix.com' : {
'Wi': WiObj, // main page selector
'Queue' : selectObj('.info', 'before', 800, 'queue-icon'), // queue page selector
},
'dvd.netflix.com' : dvdSelObj, // dvdqueue page selector
};
//search select types
SEARCH_SEL = {
//search page selectors
'Search' : selectObj('.bluray', 'append', -1, 'dvd-search-page', 'search-rt-icon'),
'WiSearch' : selectObj('.actions', 'append', -1, 'wi-search-page', 'search-rt-icon'),
};
addStyle(); //add ratings.css to the page
searchSetup(); // check if this is a search page
$.each(HOVER_SEL, function(selector, parser){ //add listeners for each hover selector
$(document).on('mouseenter', selector, parser, eventHandler);
});
});