-
Notifications
You must be signed in to change notification settings - Fork 16
/
DailyXKCD.js
225 lines (187 loc) · 6.52 KB
/
DailyXKCD.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
Module.register("DailyXKCD", {
// Default module config.
defaults: {
hostname : "xkcd.com",
dailyJsonUrlPath: "/info.0.json",
updateInterval : 10000 * 60 * 60, // 10 hours
grayScale : false,
invertColors : false,
titleFont : "bright large light",
altTextFont : "xsmall dimmed",
limitComicHeight : 450,
scrollInterval : 8000, // 8 seconds,
scrollRatio : 0.8, // scroll by 80% of visible height,
randomComic : false,
showAltText : false,
showTitle : true
},
start: function() {
Log.info(this.config);
Log.info("Starting module: " + this.name);
this.dailyComic = "";
this.dailyComicTitle = "";
this.dailyComicAlt = "";
this.autoIntervals = [];
this.getComic();
self = this;
setInterval(function() {
self.getComic();
}, self.config.updateInterval);
if (this.config.scrollInterval < 3000) {
// animation takes 3 seconds
this.config.scrollInterval = 3000;
}
// value should be between 0.0 and 1.0
this.config.scrollRatio = Math.max(this.config.scrollRatio, 0.0);
this.config.scrollRatio = Math.min(this.config.scrollRatio, 1.0);
if (this.config.limitComicHeight > 0)
{
var self = this;
// scroll comic up and down
this.addAutoSuspendingInterval(function() {
self.scrollComic();
}, this.config.scrollInterval);
this.scrollProgress = 0;
}
},
// Define required scripts.
getScripts: function() {
return ["moment.js"];
},
// Define required styles.
getStyles: function() {
return ["xkcd.css"];
},
getComic: function() {
Log.info("XKCD: Getting comic.");
this.sendSocketNotification("GET_COMIC", {
config: this.config
});
},
socketNotificationReceived: function(notification, payload) {
if (notification === "COMIC") {
Log.info(payload.img);
this.dailyComic = payload.img;
this.dailyComicTitle = payload.safe_title;
this.dailyComicAlt = payload.alt;
this.updateDom(1000);
}
},
notificationReceived: function(notification, payload, sender) {
this.checkUserPresence(notification, payload, sender);
},
// Override dom generator.
getDom: function() {
var wrapper = document.createElement("div");
var title = document.createElement("div");
title.className = this.config.titleFont;
title.innerHTML = this.dailyComicTitle;
if (this.config.showTitle) {
wrapper.appendChild(title);
}
var comicWrapper = document.createElement("div");
comicWrapper.className = "xkcdcontainer";
if (this.config.limitComicHeight > 0)
{
comicWrapper.style.maxHeight = this.config.limitComicHeight + "px";
}
var xkcd = document.createElement("img");
xkcd.id = "xkcdcontent";
xkcd.src = this.dailyComic;
if(this.config.grayScale || this.config.invertColors){
xkcd.setAttribute("style", "-webkit-filter: " +
(this.config.grayScale ? "grayscale(100%) " : "") +
(this.config.invertColors ? "invert(100%) " : "") +
";")
}
comicWrapper.appendChild(xkcd);
wrapper.appendChild(comicWrapper);
if (this.config.showAltText) {
var alt = document.createElement("div");
alt.className = this.config.altTextFont;
alt.innerHTML = this.dailyComicAlt;
wrapper.appendChild(alt);
}
return wrapper;
},
/* suspend()
* This method is called when a module is hidden.
*/
suspend: function() {
this.scrollProgress = 0;
// reset to beginning if module is suspended, so we start at the top
var scrollable = document.getElementById("xkcdcontent");
scrollable.style.top = "0px";
for (var i = 0; i < this.autoIntervals.length; i++)
{
var current = this.autoIntervals[i];
if (current.interval)
{
clearInterval(current.interval);
current.interval = null;
}
}
},
/* resume()
* This method is called when a module is shown.
*/
resume: function() {
for (var i = 0; i < this.autoIntervals.length; i++)
{
var current = this.autoIntervals[i];
if (!current.interval)
{
current.callback();
current.interval = setInterval(current.callback, current.time);
}
}
},
/* scrollComic
* Scrolls the comic down if needed
*/
scrollComic: function() {
var scrollable = document.getElementById("xkcdcontent");
var height = scrollable.naturalHeight;
var top = 0;
if (this.config.limitComicHeight > 0 && height > this.config.limitComicHeight)
{
var currentHeight = this.scrollProgress * -this.config.limitComicHeight * this.config.scrollRatio;
var maxHeight = this.config.limitComicHeight - height;
top = Math.max(currentHeight, maxHeight);
}
scrollable.style.top = top + "px";
scrollable.style.height = height + "px";
if (top == this.config.limitComicHeight - height)
{
this.scrollProgress = -1;
}
this.scrollProgress += 1;
},
/* checkUserPresence(notification, payload, sender)
* Use this method to conveniently suspend your module when no user is present.
*/
checkUserPresence: function(notification, payload, sender) {
if (sender && notification === "USER_PRESENCE") {
if (payload === true)
{
this.resume();
}
else
{
this.suspend();
}
}
},
/* addAutoSuspendingInterval(callback, time)
* Use instead of setInterval for automatic pause when on suspend.
* The callback is executed immediately once after the user returns.
*/
addAutoSuspendingInterval: function(callback, time) {
var newInterval = setInterval(callback, time);
this.autoIntervals.push({
callback: callback,
interval: newInterval,
time: time
});
}
});