Repository navigation
Expand file tree
/
Copy pathBaseController.js
More file actions
323 lines (282 loc) · 11.8 KB
/
Copy pathBaseController.js
File metadata and controls
323 lines (282 loc) · 11.8 KB
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
"use strict";
(function() {
var sk_log = require("../modules/SKLog.js");
function BaseController(options) {
this.siteName = options.siteName || null;
this.selectors = {
//** Properties **//
playPause: (options.playPause || null),
play: (options.play || null),
pause: (options.pause || null),
playNext: (options.playNext || null),
playPrev: (options.playPrev || null),
mute: (options.mute || null),
like: (options.like || null),
confirmLike: (options.confirmLike || null),
dislike: (options.dislike || null),
confirmDislike: (options.confirmDislike || null),
iframe: (options.iframe || null),
//** States **//
playState: (options.playState || null),
//** Song Info **//
song: (options.song || null),
artist: (options.artist || null),
album: (options.album || null),
art: (options.art || null),
currentTime: (options.currentTime || null),
totalTime: (options.totalTime || null)
};
// Any property that's a function, turn it into a getter
Object.defineProperties(
this.selectors,
Object.keys(this.selectors)
.reduce(function(properties, key) {
var fn = this.selectors[key];
if (typeof fn === "function") {
properties[key] = {
get: fn.bind(this)
};
}
return properties;
}.bind(this), {}));
// Previous player state, used to check vs current player state to see if anything changed
this.oldState = {};
// Set to true if the play/pause buttons share the same element
this.buttonSwitch = options.buttonSwitch || false;
// Default listener sends actions to main document
this.attachListeners();
// Set to true if the tab should be hidden from the popup unless it has a playPause element shown
this.hidePlayer = options.hidePlayer || false;
//** Overrides for popup buttons **//
this.overridePlayPrev = options.overridePlayPrev || false;
this.overridePlayPause = options.overridePlayPause || false;
this.overridePlayNext = options.overridePlayNext || false;
chrome.runtime.sendMessage({ created: true }, function() {
sk_log("SK content script loaded");
});
}
BaseController.prototype.doc = function() {
var returnDoc = document;
if (this.selectors.iframe) {
if (document.querySelector(this.selectors.iframe)) {
if (document.querySelector(this.selectors.iframe).tagName.indexOf("FRAME") > -1) {
returnDoc = document.querySelector(this.selectors.iframe).contentWindow.document;
}
}
}
return returnDoc;
};
/**
* Inject a script into the current document
* @param {String} file.url - /relative/path/to/script
* @param {String} file.script - plaintext script as a string
*/
BaseController.prototype.injectScript = function(file) {
var script = document.createElement("script");
script.setAttribute("type", "text/javascript");
if(file.url) {script.setAttribute("src", chrome.extension.getURL(file.url));}
if(file.script) {script.innerHTML = file.script;}
(document.head || document.documentElement).appendChild(script);
};
/**
* Click inside document
* @param {String} opts.selectorButton - css selector for button to click
* @param {String} opts.action - name of action to log to console for debugging purposes
* @param {String} [opts.selectorFrame] - css selector for iframe to send clicks to
*/
BaseController.prototype.click = function(opts) {
opts = opts || {};
if(opts.selectorButton === null) {
sk_log("disabled", opts.action);
return;
}
try {
this.doc().querySelector(opts.selectorButton).click();
sk_log(opts.action);
} catch(e) {
sk_log("Element not found for click.", opts.selectorButton, true);
}
// Update the player state after a click
this.updatePlayerState();
};
BaseController.prototype.playPause = function() {
if(this.selectors.play !== null && this.selectors.pause !== null) {
if(this.isPlaying()) {
this.click({action: "playPause", selectorButton: this.selectors.pause, selectorFrame: this.selectors.iframe});
} else {
this.click({action: "playPause", selectorButton: this.selectors.play, selectorFrame: this.selectors.iframe});
}
} else {
this.click({action: "playPause", selectorButton: this.selectors.playPause, selectorFrame: this.selectors.iframe});
}
};
BaseController.prototype.playNext = function() {
this.click({action: "playNext", selectorButton: this.selectors.playNext, selectorFrame: this.selectors.iframe});
};
BaseController.prototype.playPrev = function() {
this.click({action: "playPrev", selectorButton: this.selectors.playPrev, selectorFrame: this.selectors.iframe});
};
BaseController.prototype.stop = function() {
if(this.isPlaying()) this.playPause();
};
BaseController.prototype.mute = function() {
this.click({action: "mute", selectorButton: this.selectors.mute, selectorFrame: this.selectors.iframe});
};
BaseController.prototype.like = function() {
this.click({action: "like", selectorButton: this.selectors.like, selectorFrame: this.selectors.iframe});
if(this.selectors.confirmLike !== null) {
var controller = this;
var observer = new MutationObserver(function() {
this.disconnect();
controller.click({action: "confirmLike", selectorButton: controller.selectors.confirmLike, selectorFrame: controller.selectors.iframe});
});
observer.observe(document.documentElement, {childList: true, subtree: true});
}
};
BaseController.prototype.dislike = function() {
this.click({action: "dislike", selectorButton: this.selectors.dislike, selectorFrame: this.selectors.iframe});
if(this.selectors.confirmDislike !== null) {
var controller = this;
var observer = new MutationObserver(function() {
this.disconnect();
controller.click({action: "confirmDislike", selectorButton: controller.selectors.confirmDislike, selectorFrame: controller.selectors.iframe});
});
observer.observe(document.documentElement, {childList: true, subtree: true});
}
};
/**
* Attempts to check if the site is playing anything
* @return {Boolean} true if site is currently playing
*/
BaseController.prototype.isPlaying = function() {
var playEl = this.doc().querySelector(this.selectors.play),
isPlaying = false;
if(this.buttonSwitch) {
// If playEl does not exist then it is currently playing
isPlaying = (playEl === null);
}
else if(this.selectors.playState) {
// Check if the play state element exists and is visible
var playStateEl = this.doc().querySelector(this.selectors.playState);
isPlaying = !!(playStateEl && (window.getComputedStyle(playStateEl, null).getPropertyValue("display") !== "none"));
}
else if(playEl) {
isPlaying = (window.getComputedStyle(playEl, null).getPropertyValue("display") === "none");
}
return isPlaying;
};
/**
* Gets the current state of the music player and passes data to background page (and eventually popup)
*/
BaseController.prototype.updatePlayerState = function() {
if(this.checkPlayer) this.checkPlayer();
var newState = this.getStateData();
if(JSON.stringify(newState) !== JSON.stringify(this.oldState)) {
sk_log("Player state change");
if(this.getSongChanged(newState)) {
chrome.runtime.sendMessage({
action: "send_change_notification",
stateData: newState
});
}
this.oldState = newState;
chrome.runtime.sendMessage({
action: "update_player_state",
stateData: newState
});
}
};
/**
* Gets an object containing the current player state data
* @return {{song: {String}, artist: {String}, isPlaying: {Boolean}, siteName: {String}}}
*/
BaseController.prototype.getStateData = function() {
return {
song: (this.getSongData(this.selectors.song) === null ? null : this.getSongData(this.selectors.song).replace(/\s+/g, " ")),
artist: (this.getSongData(this.selectors.artist) === null ? null : this.getSongData(this.selectors.artist).replace(/\s+/g, " ")),
album: (this.getSongData(this.selectors.album) === null ? null : this.getSongData(this.selectors.album).replace(/\s+/g, " ")),
art: this.getArtData(this.selectors.art),
currentTime: this.getSongData(this.selectors.currentTime),
totalTime: this.getSongData(this.selectors.totalTime),
isPlaying: this.isPlaying(),
siteName: (this.siteName == null ? null : this.siteName.replace(/\s+/g, " ")),
canDislike: !!(this.selectors.dislike && this.doc().querySelector(this.selectors.dislike)),
canPlayPrev: this.overridePlayPrev || !!(this.selectors.playPrev && this.doc().querySelector(this.selectors.playPrev)),
canPlayPause: this.overridePlayPause || !!(
(this.selectors.playPause && this.doc().querySelector(this.selectors.playPause)) ||
(this.selectors.play && this.doc().querySelector(this.selectors.play)) ||
(this.selectors.pause && this.doc().querySelector(this.selectors.pause))
),
canPlayNext: this.overridePlayNext || !!(this.selectors.playNext && this.doc().querySelector(this.selectors.playNext)),
canLike: !!(this.selectors.like && this.doc().querySelector(this.selectors.like)),
hidePlayer: this.hidePlayer
};
};
/**
* Returns a bool indicating whether the player's song changed since the last state update
* @param {{song: {String}}} newState - new state object
* @return {Boolean} true if song just changed, false otherwise
*/
BaseController.prototype.getSongChanged = function(newState) {
return this.oldState &&
newState &&
this.oldState.song !== newState.song;
};
/**
* Gets the text value from a song data selector
* @param {String} selector - selector for song data
* @return {*} song data if element is found, null otherwise
*/
BaseController.prototype.getSongData = function(selector) {
if(!selector) return null;
var dataEl = this.doc().querySelector(selector);
if(dataEl && dataEl.textContent) {
return dataEl.textContent;
}
return null;
};
BaseController.prototype.getArtData = function(selector) {
if(!selector) return null;
var dataEl = this.doc().querySelector(selector);
if(dataEl && dataEl.attributes && dataEl.attributes.src) {
return dataEl.attributes.src.value;
}
return null;
};
/**
* Callback for request from background page
*/
BaseController.prototype.doRequest = function(request, sender, response) {
if(typeof request !== "undefined") {
if(request.action === "playPause") this.playPause();
if(request.action === "playNext") this.playNext();
if(request.action === "playPrev") this.playPrev();
if(request.action === "stop") this.stop();
if(request.action === "mute") this.mute();
if(request.action === "like") this.like();
if(request.action === "dislike") this.dislike();
if(request.action === "playerStateNotify"){
chrome.runtime.sendMessage({
action: "send_change_notification",
stateData: this.getStateData()
});
}
if(request.action === "getPlayerState") {
var newState = this.getStateData();
this.oldState = newState;
response(newState);
}
}
};
/**
* Setup listeners for extension messages. Initialize the playerState interval
*/
BaseController.prototype.attachListeners = function() {
// Listener for requests from background page
chrome.runtime.onMessage.addListener(this.doRequest.bind(this));
// Update the popup player state intermittently
setInterval(this.updatePlayerState.bind(this), 200);
sk_log("Attached listener for ", this);
};
module.exports = BaseController;
})();